[Sync] Refactor sync datatype error handling.

chrome/browser/sync/api/sync_error.h

+// Copyright (c) 2011 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_SYNC_API_SYNC_ERROR_H_
+#define CHROME_BROWSER_SYNC_API_SYNC_ERROR_H_
+#pragma once
+
+#include <string>
+
+#include "base/memory/scoped_ptr.h"
+#include "chrome/browser/sync/syncable/model_type.h"
+
+namespace tracked_objects {
+class Location;
+}

[akalin, 2011/07/22 00:10:05]

}  // namespace tracked_objects

[Nicolas Zea, 2011/07/25 20:57:28]

Done.

+
+// Sync errors are used for debug purposes and handled internally and/or
+// exposed through Chrome's "about:sync" internal page. They are considered
+// unrecoverable for the datatype creating them, and should only be used as
+// such.
+// This class is copy-friendly and thread-safe.
+class SyncError {
+ public:
+  // Default constructor refers to "no error", and IsInitialized() will return

[akalin, 2011/07/22 00:10:05]

I wonder if it would be better to have all the functions that return bool and
fill in a SyncError* on false, instead return a SyncError, and change
IsInitialized() to HasError(), and have the caller check that instead.  Might be
less clumsy.  What do you think?

[Nicolas Zea, 2011/07/25 20:57:28]

Yeah, I  like that better. Done.

+  // false.
+  SyncError();
+
+  // Create a new Sync error triggered by datatype |type| with debug message
+  // |message| from the specified location.
+  SyncError(const tracked_objects::Location& location,
+            const std::string& message,
+            syncable::ModelType type);
+
+  // Copy and assign via deep copy.
+  SyncError(const SyncError& other);
+  SyncError& operator=(const SyncError& other);
+
+  // Reset the error to a new error.
+  // May be called irrespective of whether is_set() is true.

[akalin, 2011/07/22 00:10:05]

is_set -> IsInitialized()

[Nicolas Zea, 2011/07/25 20:57:28]

Done.

+  void Reset(const tracked_objects::Location& location,
+             const std::string& message,
+             syncable::ModelType type);
+
+  // Whether this is a valid error or not.
+  bool IsInitialized() const;
+
+  // These must only be called if is_set() is true.
+  const tracked_objects::Location& location() const;
+  const std::string& message() const;
+  const syncable::ModelType type() const;
+
+ private:
+  // Print error information to log.
+  void PrintLogError() const;
+
+  // Scoped_ptr is necessary because Location objects aren't assignable.

[akalin, 2011/07/22 00:10:05]

Scoped -> scoped

[Nicolas Zea, 2011/07/25 20:57:28]

Done.

+  scoped_ptr<tracked_objects::Location> location_;
+  std::string message_;
+  syncable::ModelType type_;
+};
+
+#endif  // CHROME_BROWSER_SYNC_API_SYNC_ERROR_H_