chrome/browser/sync/test/integration/sync_app_helper.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_SYNC_TEST_INTEGRATION_SYNC_APP_HELPER_H_
#define CHROME_BROWSER_SYNC_TEST_INTEGRATION_SYNC_APP_HELPER_H_

#include <string>

#include "base/basictypes.h"
#include "base/memory/singleton.h"
#include "sync/api/string_ordinal.h"

class Profile;
class SyncTest;

class SyncAppHelper {
 public:
  // Singleton implementation.
  static SyncAppHelper* GetInstance();

  // Initializes the profiles in |test| and registers them with
  // internal data structures.
  void SetupIfNecessary(SyncTest* test);

  // Returns true iff |profile1| and |profile2| have the same apps and
  // they are all in the same state.
  bool AppStatesMatch(Profile* profile1, Profile* profile2);

  // Gets the page ordinal value for the applications with |name| in |profile|.
  syncer::StringOrdinal GetPageOrdinalForApp(Profile* profile,
                                             const std::string& name);

  // Sets a new |page_ordinal| value for the application with |name| in
  // |profile|.
  void SetPageOrdinalForApp(Profile* profile,
                            const std::string& name,
                            const syncer::StringOrdinal& page_ordinal);

  // Gets the app launch ordinal value for the application with |name| in
  // |profile|.
  syncer::StringOrdinal GetAppLaunchOrdinalForApp(Profile* profile,
                                                  const std::string& name);

  // Sets a new |app_launch_ordinal| value for the application with |name| in
  // |profile|.
  void SetAppLaunchOrdinalForApp(
      Profile* profile,
      const std::string& name,
      const syncer::StringOrdinal& app_launch_ordinal);

  // Fix any NTP icon collisions that are currently in |profile|.
  void FixNTPOrdinalCollisions(Profile* profile);

 private:
  friend struct DefaultSingletonTraits<SyncAppHelper>;

  SyncAppHelper();
  ~SyncAppHelper();

  bool setup_completed_;

  DISALLOW_COPY_AND_ASSIGN(SyncAppHelper);
};

#endif  // CHROME_BROWSER_SYNC_TEST_INTEGRATION_SYNC_APP_HELPER_H_