Improve reliability of custom spelling dictionary file.

chrome/browser/spellchecker/spellcheck_custom_dictionary.h

 // 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.
 
 #ifndef CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_CUSTOM_DICTIONARY_H_
 #define CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_CUSTOM_DICTIONARY_H_
 
 #include <string>
 #include <vector>
 
 #include "base/file_path.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
+#include "base/observer_list.h"
 #include "chrome/browser/spellchecker/spellcheck_dictionary.h"
 #include "chrome/common/spellcheck_common.h"
 
 // Defines a custom dictionary which users can add their own words to.
 class SpellcheckCustomDictionary : public SpellcheckDictionary {
  public:
   class Observer {
    public:
     virtual void OnCustomDictionaryLoaded() = 0;
     virtual void OnCustomDictionaryWordAdded(const std::string& word) = 0;
@@ skipping 44 matching lines @@
   // The caller owns this new list.
   chrome::spellcheck_common::WordList* LoadDictionary();
 
   // The reply point for PostTaskAndReplyWithResult. Called when LoadDictionary
   // is finished reading words from custom dictionary file. Moves the strings
   // from the |custom_words| argument into the private member variable |words_|
   // and deletes the memory at |custom_words|.
   void SetCustomWordListAndDelete(
       chrome::spellcheck_common::WordList* custom_words);
 
+  // Loads the dictionary file into |contents|. If the dictionary checksum is
+  // not valid, but backup checksum is valid, then restores the backup and loads
+  // that into |contents| instead.
+  void LoadDictionaryContentsReliably(std::string* contents);

[groby-ooo-7-16, 2012/12/04 00:16:30]

We should probably document somewhere that we expect our files to be UTF8, not
some fancy windows codepage or anything.

[please use gerrit instead, 2012/12/04 05:46:40]

Where is the best place to document this? Class comments? Method comments? Line
comments inside of LoadDictionaryContentsReliably?

+
+  // Backs up the original dictionary and checksum files, saves |contents| into
+  // the dictionary file, and saves the checksum of |contents| into the checksum
+  // file.

[groby-ooo-7-16, 2012/12/04 00:16:30]

I'd feel more comfortable having the checksum in the dictionary file, as the
first or last line. At least that way, you can still save dictionary files for
later use.

[please use gerrit instead, 2012/12/04 05:46:40]

Done.

+  void SaveDictionryContentsReliably(const std::string& contents);

[groby-ooo-7-16, 2012/12/04 00:16:30]

Spelling: Diction_a_ry (Hey, y u no spellcheck! ;)

[please use gerrit instead, 2012/12/04 05:46:40]

Done.

+
+  // Extract the |checksum| out of |contents|.
+  std::string GetChecksum(std::string* contents);

[groby-ooo-7-16, 2012/12/04 00:16:30]

const std::string& contents - it's not an out param.

[please use gerrit instead, 2012/12/04 05:46:40]

Added a comment to clarify: "If this method returns a non-empty checksum, then
|contents| have been truncated to exclude the checksum."

+
   // In-memory cache of the custom words file.
   chrome::spellcheck_common::WordList words_;
 
   // A path for custom dictionary per profile.
   FilePath custom_dictionary_path_;
 
   base::WeakPtrFactory<SpellcheckCustomDictionary> weak_ptr_factory_;
 
-  std::vector<Observer*> observers_;
+  ObserverList<Observer> observers_;
+
+  const FilePath::StringType backup_extension_;
+  const std::string checksum_prefix_;
 
   DISALLOW_COPY_AND_ASSIGN(SpellcheckCustomDictionary);
 };
 
 #endif  // CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_CUSTOM_DICTIONARY_H_