123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- // Copyright 2014 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_SEARCH_ENGINES_TEMPLATE_URL_PARSER_H_
- #define COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PARSER_H_
- #include <stddef.h>
- #include <memory>
- #include <string>
- #include "base/callback.h"
- class SearchTermsData;
- class TemplateURL;
- namespace data_decoder {
- class DataDecoder;
- }
- // TemplateURLParser, as the name implies, handling reading of TemplateURLs
- // from OpenSearch description documents.
- class TemplateURLParser {
- public:
- // A ParameterFilter is called for every URL paramter encountered during
- // Parse(). It passes the parameter key as the first argument and the value
- // as the second. The callback should return true if the parameter should be
- // kept, and false if it should be discarded.
- using ParameterFilter =
- base::RepeatingCallback<bool(const std::string&, const std::string&)>;
- using ParseCallback = base::OnceCallback<void(std::unique_ptr<TemplateURL>)>;
- TemplateURLParser(const TemplateURLParser&) = delete;
- TemplateURLParser& operator=(const TemplateURLParser&) = delete;
- // Decodes the chunk of data representing a TemplateURL, creates the
- // TemplateURL, and calls the |completion_callback| with the result. A null
- // value is provided if the data does not describe a valid TemplateURL, the
- // URLs referenced do not point to valid http/https resources, or for some
- // other reason we do not support the described TemplateURL.
- // |parameter_filter| can be used if you want to filter some parameters out
- // of the URL. For example, when importing from another browser, we remove
- // any parameter identifying that browser. If set to null, the URL is not
- // modified.
- static void Parse(const SearchTermsData* search_terms_data,
- const std::string& data,
- const ParameterFilter& parameter_filter,
- ParseCallback completion_callback);
- // The same as Parse(), but it allows the caller to manage the lifetime of
- // the DataDecoder service. The |data_decoder| must be kept alive until the
- // |completion_callback| is called.
- static void ParseWithDataDecoder(data_decoder::DataDecoder* data_decoder,
- const SearchTermsData* search_terms_data,
- const std::string& data,
- const ParameterFilter& parameter_filter,
- ParseCallback completion_callback);
- private:
- // No one should create one of these.
- TemplateURLParser();
- };
- #endif // COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_PARSER_H_
|