1// Copyright 2011 Google Inc. 2// All rights reserved. 3// 4// Redistribution and use in source and binary forms, with or without 5// modification, are permitted provided that the following conditions are 6// met: 7// 8// * Redistributions of source code must retain the above copyright 9// notice, this list of conditions and the following disclaimer. 10// * Redistributions in binary form must reproduce the above copyright 11// notice, this list of conditions and the following disclaimer in the 12// documentation and/or other materials provided with the distribution. 13// * Neither the name of Google Inc. nor the names of its contributors 14// may be used to endorse or promote products derived from this software 15// without specific prior written permission. 16// 17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29/// \file engine/action.hpp 30/// Representation of user-initiated actions. 31 32#if !defined(ENGINE_ACTION_HPP) 33#define ENGINE_ACTION_HPP 34 35#include <ostream> 36 37#include "utils/shared_ptr.hpp" 38 39namespace engine { 40 41 42class context; 43 44 45/// Representation of an action. 46/// 47/// The instances of this class are unique (i.e. copying the objects only yields 48/// a shallow copy that shares the same internal implementation). This is a 49/// requirement for the 'store' API model. 50class action { 51 struct impl; 52 53 /// Pointer to the shared internal implementation. 54 std::shared_ptr< impl > _pimpl; 55 56public: 57 explicit action(const context&); 58 ~action(void); 59 60 const context& runtime_context(void) const; 61 62 bool operator==(const action&) const; 63 bool operator!=(const action&) const; 64}; 65 66 67std::ostream& operator<<(std::ostream&, const action&); 68 69 70} // namespace engine 71 72#endif // !defined(ENGINE_ACTION_HPP) 73