minix/external/bsd/kyua-cli/dist/engine/action.hpp

73 lines
2.4 KiB
C++
Raw Normal View History

// Copyright 2011 Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of Google Inc. nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/// \file engine/action.hpp
/// Representation of user-initiated actions.
#if !defined(ENGINE_ACTION_HPP)
#define ENGINE_ACTION_HPP
#include <ostream>
#include "utils/shared_ptr.hpp"
namespace engine {
class context;
/// Representation of an action.
///
/// The instances of this class are unique (i.e. copying the objects only yields
/// a shallow copy that shares the same internal implementation). This is a
/// requirement for the 'store' API model.
class action {
struct impl;
/// Pointer to the shared internal implementation.
std::shared_ptr< impl > _pimpl;
public:
explicit action(const context&);
~action(void);
const context& runtime_context(void) const;
bool operator==(const action&) const;
bool operator!=(const action&) const;
};
std::ostream& operator<<(std::ostream&, const action&);
} // namespace engine
#endif // !defined(ENGINE_ACTION_HPP)