// 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 MEDIA_BASE_MOCK_CALLBACK_H_
#define MEDIA_BASE_MOCK_CALLBACK_H_

#include "base/callback.h"
#include "media/base/pipeline_status.h"
#include "testing/gmock/include/gmock/gmock.h"

namespace media {

// Helper class used to test that callbacks are executed.
//
// In most cases NewExpectedCallback() can be used but if need be you can
// manually set expectations on an MockCallback object:
//
//   StrictMock<MockCallback>* callback =
//       new StrictMock<MockCallback>();
//   EXPECT_CALL(*callback, RunWithParams(_));
//   EXPECT_CALL(*callback, Destructor());
//
// ...or the equivalent and less verbose:
//   StrictMock<MockCallback>* callback =
//       new StrictMock<MockCallback>();
//   callback->ExpectRunAndDelete();
//
// ...or if you don't care about verifying callback deletion:
//
//   NiceMock<MockCallback>* callback =
//       new NiceMock<MockCallback>();
//   EXPECT_CALL(*callback, RunWithParams(_));
class MockCallback : public CallbackRunner<Tuple0> {
 public:
  MockCallback();
  virtual ~MockCallback();

  MOCK_METHOD1(RunWithParams, void(const Tuple0& params));

  // Can be used to verify the object is destroyed.
  MOCK_METHOD0(Destructor, void());

  // Convenience function to set expectations for the callback to execute and
  // deleted.
  void ExpectRunAndDelete();

 private:
  DISALLOW_COPY_AND_ASSIGN(MockCallback);
};

// Helper class similar to MockCallback but is used where a
// PipelineStatusCallback is needed.
class MockStatusCallback : public CallbackRunner<Tuple1<PipelineStatus> > {
 public:
  MockStatusCallback();
  virtual ~MockStatusCallback();

  MOCK_METHOD1(RunWithParams, void(const Tuple1<PipelineStatus>& params));

  // Can be used to verify the object is destroyed.
  MOCK_METHOD0(Destructor, void());

  // Convenience function to set expectations for the callback to execute and
  // deleted.
  void ExpectRunAndDelete(PipelineStatus status);

 private:
  DISALLOW_COPY_AND_ASSIGN(MockStatusCallback);
};

// Convenience functions that automatically create and set an expectation for
// the callback to run.
MockCallback* NewExpectedCallback();
MockStatusCallback* NewExpectedStatusCallback(PipelineStatus status);

}  // namespace media

#endif  // MEDIA_BASE_MOCK_CALLBACK_H_