1// Copyright 2011 The Kyua Authors. 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 model/context.hpp 30/// Representation of runtime contexts. 31 32#if !defined(MODEL_CONTEXT_HPP) 33#define MODEL_CONTEXT_HPP 34 35#include "model/context_fwd.hpp" 36 37#include <map> 38#include <memory> 39#include <ostream> 40#include <string> 41 42#include "utils/fs/path_fwd.hpp" 43 44namespace model { 45 46 47/// Representation of a runtime context. 48/// 49/// The instances of this class are unique (i.e. copying the objects only yields 50/// a shallow copy that shares the same internal implementation). This is a 51/// requirement for the 'store' API model. 52class context { 53 struct impl; 54 55 /// Pointer to the shared internal implementation. 56 std::shared_ptr< impl > _pimpl; 57 58public: 59 context(const utils::fs::path&, 60 const std::map< std::string, std::string >&); 61 ~context(void); 62 63 const utils::fs::path& cwd(void) const; 64 const std::map< std::string, std::string >& env(void) const; 65 66 bool operator==(const context&) const; 67 bool operator!=(const context&) const; 68}; 69 70 71std::ostream& operator<<(std::ostream&, const context&); 72 73 74} // namespace model 75 76#endif // !defined(MODEL_CONTEXT_HPP) 77