Moving prepopulated search engines to a JSON file.

chrome/browser/search_engines/template_url_prepopulate_data.cc

 // Copyright (c) 2012 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.
 
 #include "chrome/browser/search_engines/template_url_prepopulate_data.h"
 
 #if defined(OS_POSIX) && !defined(OS_MACOSX)
 #include <locale.h>
 #endif
 
@@ skipping 14 matching lines @@
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "content/public/browser/browser_thread.h"
 #include "googleurl/src/gurl.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
+#include "prepopulated_engines.h"
+
+using namespace search_engines;

[Peter Kasting, 2012/11/08 19:02:25]

This is banned by the style guide

[beaudoin, 2012/11/08 19:39:01]

I didn't like it either. Other options I can think of:
- Use the namespace qualifier everywhere. Drawback: it will bloat this file.
- Change the namespace to a class, make the variables static, move the content
of this file to the class itself. Drawback: it will change this file
significantly.
- Generate more than only the PrepopulatedEngine from JSON. (ie. the engines_*
arrays). Drawback: more complex python code.

[beaudoin, 2012/11/09 04:16:53]

Found an elegant fix by using the same namespace for the generated file as for
this one.

+
 #if defined(OS_WIN)
 #undef IN  // On Windows, windef.h defines this, which screws up "India" cases.
 #elif defined(OS_MACOSX)
 #include "base/mac/scoped_cftyperef.h"
 #endif
 
 namespace {
 
 // NOTE: See comments in GetDataVersion() below!  You should probably not change
 // the data in this file without changing the result of that function!
 
-// Engine definitions //////////////////////////////////////////////////////////
-
-struct PrepopulatedEngine {
-  const wchar_t* const name;
-  const wchar_t* const keyword;
-  const char* const favicon_url;  // If NULL, there is no favicon.
-  const char* const search_url;
-  const char* const encoding;
-  const char* const suggest_url;  // If NULL, this engine does not support
-                                  // suggestions.
-  const char* const instant_url;  // If NULL, this engine does not support
-                                  // instant.
-  // A JSON array containing a list of URL patterns that can be used, in
-  // addition to |search_url|, to extract search terms from a URL. Can be NULL.
-  const char* const alternate_urls;
-  // SEARCH_ENGINE_OTHER if there is no matching type.
-  const SearchEngineType type;
-  // Unique id for this prepopulate engine (corresponds to
-  // TemplateURL::prepopulate_id). This ID must be greater than zero and must
-  // remain the same for a particular site regardless of how the url changes;
-  // the ID is used when modifying engine data in subsequent versions, so that
-  // we can find the "old" entry to update even when the name or URL changes.
-  //
-  // This ID must be "unique" within one country's prepopulated data, but two
-  // entries can share an ID if they represent the "same" engine (e.g. Yahoo! US
-  // vs. Yahoo! UK) and will not appear in the same user-visible data set.  This
-  // facilitates changes like adding more specific per-country data in the
-  // future; in such a case the localized engines will transparently replace the
-  // previous, non-localized versions.  For engines where we need two instances
-  // to appear for one country (e.g. Bing Search U.S. English and Spanish), we
-  // must use two different unique IDs (and different keywords).
-  //
-  // The following unique IDs are available:
-  //    53, 56, 58, 60, 61, 64, 65, 66, 70, 74, 78, 79, 80, 81, 84, 86, 88, 91,
-  //    92, 93, 94, 95, 96, 97, 98, 99, 102+
-  //
-  // IDs > 1000 are reserved for distribution custom engines.
-  //
-  // NOTES:
-  //   CHANGE THE ABOVE NUMBERS IF YOU ADD A NEW ENGINE; ID conflicts = bad!
-  //   CHANGE kMaxPrepopulatedEngineID below if you add new engine outside
-  //       of the current range or it will not be counted in stats.
-  const int id;
-};
-
 // Prepopulated engines ////////////////////////////////////////////////////////
 
 // The following engines are included in country lists and are added to the list
 // of search engines on the first run depending on user's country.
 
-const PrepopulatedEngine abcsok = {
-  L"ABC S\x00f8k",
-  L"abcsok.no",
-  "http://abcsok.no/favicon.ico",
-  "http://abcsok.no/index.html?q={searchTerms}",
-  "UTF-8",
-  NULL,
-  NULL,
-  NULL,
-  SEARCH_ENGINE_ABCSOK,
-  72,
-};
-
-const PrepopulatedEngine altavista = {
-  L"AltaVista",
-  L"altavista.com",
-  "http://www.altavista.com/favicon.ico",
-  "http://www.altavista.com/web/results?q={searchTerms}",
-  "UTF-8",
-  NULL,
-  NULL,
-  NULL,
-  SEARCH_ENGINE_ALTAVISTA,
-  89,
-};
-
 const PrepopulatedEngine altavista_ar = {
   L"AltaVista",
   L"ar.altavista.com",
   "http://ar.altavista.com/favicon.ico",
   "http://ar.altavista.com/web/results?q={searchTerms}",
   "UTF-8",
   NULL,
   NULL,
   NULL,
   SEARCH_ENGINE_ALTAVISTA,
@@ skipping 3576 matching lines @@
     g_country_code_at_install = kCountryIDUnknown;
   } else {
     g_country_code_at_install =
         CountryCharsToCountryIDWithUpdate(country_code[0], country_code[1]);
   }
 }
 
 #endif
 
 }  // namespace TemplateURLPrepopulateData