1e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// Copyright (C) 2014 Google Inc. 2e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// 3e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// Licensed under the Apache License, Version 2.0 (the "License"); 4e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// you may not use this file except in compliance with the License. 5e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// You may obtain a copy of the License at 6e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// 7e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// http://www.apache.org/licenses/LICENSE-2.0 8e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// 9e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// Unless required by applicable law or agreed to in writing, software 10e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// distributed under the License is distributed on an "AS IS" BASIS, 11e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// See the License for the specific language governing permissions and 13e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// limitations under the License. 14e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 15e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#ifndef I18N_ADDRESSINPUT_PRELOAD_SUPPLIER_H_ 16e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#define I18N_ADDRESSINPUT_PRELOAD_SUPPLIER_H_ 17e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 18e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#include <libaddressinput/callback.h> 19e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#include <libaddressinput/supplier.h> 20e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#include <libaddressinput/util/basictypes.h> 21e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#include <libaddressinput/util/scoped_ptr.h> 22e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 230ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org#include <map> 24e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#include <set> 25e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#include <string> 2657f18e75e08e979cb352c05ab57b2c5567fd74f9roubert@google.com#include <vector> 27e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 28e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comnamespace i18n { 29e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comnamespace addressinput { 30e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 3190e624a56973856b6b81112fc1cd815a4224aa96roubert@google.comclass IndexMap; 32e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comclass LookupKey; 33e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comclass Retriever; 34e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comclass Rule; 358466869ca5e66ec41d133c8ca2f25789028ef4dfroubert@google.comclass Source; 36e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comclass Storage; 37e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 38e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// An implementation of the Supplier interface that owns a Retriever object, 39e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// through which it can load aggregated address metadata for a region when 40e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// instructed to, creating Rule objects and caching these. It also provides 41e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// methods to check whether metadata for a particular region is already loaded 42e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// or in progress of being loaded. 43e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// 44e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// When using a PreloadSupplier, it becomes possible to do synchronous address 458466869ca5e66ec41d133c8ca2f25789028ef4dfroubert@google.com// validation using an asynchronous Source, and to have full control over when 468466869ca5e66ec41d133c8ca2f25789028ef4dfroubert@google.com// network access is being done. 47e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// 48e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// The maximum size of this cache is naturally limited to the amount of data 49e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// available from the data server. (Currently this is less than 12,000 items of 50e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com// in total less than 2 MB of JSON data.) 51e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.comclass PreloadSupplier : public Supplier { 52e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com public: 538c9b0e35847b85f4cc7434058e4e4ec5d5560c40roubert@google.com typedef i18n::addressinput::Callback<const std::string&, int> Callback; 54e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 558466869ca5e66ec41d133c8ca2f25789028ef4dfroubert@google.com // Takes ownership of |source| and |storage|. 568466869ca5e66ec41d133c8ca2f25789028ef4dfroubert@google.com PreloadSupplier(const Source* source, Storage* storage); 57e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com virtual ~PreloadSupplier(); 58e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 59e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // Collects the metadata needed for |lookup_key| from the cache, then calls 60e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // |supplied|. If the metadata needed isn't found in the cache, it will call 61e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // the callback with status false. 62e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com virtual void Supply(const LookupKey& lookup_key, 63e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com const Supplier::Callback& supplied); 64e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 65078d6be1820cd1347817cc02f56be1aedbada96erouslan@chromium.org // Should be called only when IsLoaded() returns true for the region code of 66078d6be1820cd1347817cc02f56be1aedbada96erouslan@chromium.org // the |lookup_key|. Can return NULL if the |lookup_key| does not correspond 67078d6be1820cd1347817cc02f56be1aedbada96erouslan@chromium.org // to any rule data. The caller does not own the result. 682fbc3617221414ff659533aaf8033526443b3773rouslan@chromium.org const Rule* GetRule(const LookupKey& lookup_key) const; 69078d6be1820cd1347817cc02f56be1aedbada96erouslan@chromium.org 70e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // Loads all address metadata available for |region_code|. (A typical data 71e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // size is 10 kB. The largest is 250 kB.) 72e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // 73e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // If the rules are already in progress of being loaded, it does nothing. 74e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com // Calls |loaded| when the loading has finished. 75e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com void LoadRules(const std::string& region_code, const Callback& loaded); 76e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 770ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org // Returns a mapping of lookup keys to rules. Should be called only when 780ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org // IsLoaded() returns true for the |region_code|. 790ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org const std::map<std::string, const Rule*>& GetRulesForRegion( 800ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org const std::string& region_code) const; 810ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org 82e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com bool IsLoaded(const std::string& region_code) const; 83e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com bool IsPending(const std::string& region_code) const; 84e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 85e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com private: 862fbc3617221414ff659533aaf8033526443b3773rouslan@chromium.org bool GetRuleHierarchy(const LookupKey& lookup_key, 872fbc3617221414ff659533aaf8033526443b3773rouslan@chromium.org RuleHierarchy* hierarchy) const; 88e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com bool IsLoadedKey(const std::string& key) const; 89e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com bool IsPendingKey(const std::string& key) const; 90e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 91e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com const scoped_ptr<const Retriever> retriever_; 92e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com std::set<std::string> pending_; 9390e624a56973856b6b81112fc1cd815a4224aa96roubert@google.com const scoped_ptr<IndexMap> rule_index_; 9457f18e75e08e979cb352c05ab57b2c5567fd74f9roubert@google.com std::vector<const Rule*> rule_storage_; 950ddcd24a82f60578ab843feae5bea5545989cb96rouslan@chromium.org std::map<std::string, std::map<std::string, const Rule*> > region_rules_; 96e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 97e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com DISALLOW_COPY_AND_ASSIGN(PreloadSupplier); 98e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com}; 99e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 100e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com} // namespace addressinput 101e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com} // namespace i18n 102e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com 103e5f672fe910c47ac8e4cefe4becdb3db7cca0a38roubert@google.com#endif // I18N_ADDRESSINPUT_PRELOAD_SUPPLIER_H_ 104