#pragma once /* * Global.h, part of VCMI engine * * Authors: listed in file AUTHORS in main folder * * License: GNU General Public License v2.0 or later * Full text of license available in license.txt file, in main folder * */ /* ---------------------------------------------------------------------------- */ /* Compiler detection */ /* ---------------------------------------------------------------------------- */ // Fixed width bool data type is important for serialization static_assert(sizeof(bool) == 1, "Bool needs to be 1 byte in size."); #ifdef __GNUC__ # define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__ * 10 + __GNUC_PATCHLEVEL__) #endif #if !defined(__clang__) && defined(__GNUC__) && (GCC_VERSION < 470) # error VCMI requires at least gcc-4.7.2 for successful compilation or clang-3.1. Please update your compiler #endif #if defined(__GNUC__) && (GCC_VERSION == 470 || GCC_VERSION == 471) # error This GCC version has buggy std::array::at version and should not be used. Please update to 4.7.2 or later #endif /* ---------------------------------------------------------------------------- */ /* Suppress some compiler warnings */ /* ---------------------------------------------------------------------------- */ #ifdef _MSC_VER # pragma warning (disable : 4800 ) /* disable conversion to bool warning -- I think it's intended in all places */ #endif /* ---------------------------------------------------------------------------- */ /* System detection. */ /* ---------------------------------------------------------------------------- */ // Based on: http://sourceforge.net/p/predef/wiki/OperatingSystems/ // and on: http://stackoverflow.com/questions/5919996/how-to-detect-reliably-mac-os-x-ios-linux-windows-in-c-preprocessor // TODO?: Should be moved to vstd\os_detect.h (and then included by Global.h) #ifdef _WIN16 // Defined for 16-bit environments # error "16-bit Windows isn't supported" #elif defined(_WIN64) // Defined for 64-bit environments # define VCMI_WINDOWS # define VCMI_WINDOWS_64 #elif defined(_WIN32) // Defined for both 32-bit and 64-bit environments # define VCMI_WINDOWS # define VCMI_WINDOWS_32 #elif defined(_WIN32_WCE) # error "Windows CE isn't supported" #elif defined(__linux__) || defined(__gnu_linux__) || defined(linux) || defined(__linux) # define VCMI_UNIX # define VCMI_XDG # ifdef __ANDROID__ # define VCMI_ANDROID # endif #elif defined(__FreeBSD_kernel__) || defined(__FreeBSD__) # define VCMI_UNIX # define VCMI_XDG # define VCMI_FREEBSD #elif defined(__GNU__) || defined(__gnu_hurd__) || (defined(__MACH__) && !defined(__APPLE)) # define VCMI_UNIX # define VCMI_XDG # define VCMI_HURD #elif defined(__APPLE__) && defined(__MACH__) # define VCMI_UNIX # define VCMI_APPLE # include "TargetConditionals.h" # if TARGET_IPHONE_SIMULATOR # define VCMI_IOS # define VCMI_IOS_SIM # elif TARGET_OS_IPHONE # define VCMI_IOS # elif TARGET_OS_MAC # define VCMI_MAC # else //# warning "Unknown Apple target."? # endif #else # error "VCMI supports only Windows, OSX, Linux and Android targets" #endif #ifdef VCMI_IOS # error "iOS system isn't yet supported." #endif /* ---------------------------------------------------------------------------- */ /* Commonly used C++, Boost headers */ /* ---------------------------------------------------------------------------- */ #ifdef VCMI_WINDOWS # define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers - delete this line if something is missing. # define NOMINMAX // Exclude min/max macros from . Use std::[min/max] from instead. #endif #define _USE_MATH_DEFINES #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include //The only available version is 3, as of Boost 1.50 #include #define BOOST_FILESYSTEM_VERSION 3 #if BOOST_VERSION > 105000 # define BOOST_THREAD_VERSION 3 #endif #define BOOST_THREAD_DONT_PROVIDE_THREAD_DESTRUCTOR_CALLS_TERMINATE_IF_JOINABLE 1 #define BOOST_BIND_NO_PLACEHOLDERS #include #include #include #include #include #include #include #include #include #include #include #include #ifndef VCMI_ANDROID #include #endif #include #include #include #include #include #include #include #include #include #ifndef M_PI # define M_PI 3.14159265358979323846 #endif /* ---------------------------------------------------------------------------- */ /* Usings */ /* ---------------------------------------------------------------------------- */ using std::shared_ptr; using std::unique_ptr; using std::make_shared; using namespace std::placeholders; namespace range = boost::range; /* ---------------------------------------------------------------------------- */ /* Typedefs */ /* ---------------------------------------------------------------------------- */ // Integral data types typedef boost::uint64_t ui64; //unsigned int 64 bits (8 bytes) typedef boost::uint32_t ui32; //unsigned int 32 bits (4 bytes) typedef boost::uint16_t ui16; //unsigned int 16 bits (2 bytes) typedef boost::uint8_t ui8; //unsigned int 8 bits (1 byte) typedef boost::int64_t si64; //signed int 64 bits (8 bytes) typedef boost::int32_t si32; //signed int 32 bits (4 bytes) typedef boost::int16_t si16; //signed int 16 bits (2 bytes) typedef boost::int8_t si8; //signed int 8 bits (1 byte) // Lock typedefs typedef boost::lock_guard TLockGuard; typedef boost::lock_guard TLockGuardRec; /* ---------------------------------------------------------------------------- */ /* Macros */ /* ---------------------------------------------------------------------------- */ // Import + Export macro declarations #ifdef VCMI_WINDOWS # ifdef __GNUC__ # define DLL_IMPORT __attribute__((dllimport)) # define DLL_EXPORT __attribute__((dllexport)) # else # define DLL_IMPORT __declspec(dllimport) # define DLL_EXPORT __declspec(dllexport) # endif # define ELF_VISIBILITY #else # ifdef __GNUC__ # define DLL_IMPORT __attribute__ ((visibility("default"))) # define DLL_EXPORT __attribute__ ((visibility("default"))) # define ELF_VISIBILITY __attribute__ ((visibility("default"))) # define ELF_VISIBILITY __attribute__ ((visibility("default"))) # endif #endif #ifdef VCMI_DLL # define DLL_LINKAGE DLL_EXPORT #else # define DLL_LINKAGE DLL_IMPORT #endif #define THROW_FORMAT(message, formatting_elems) throw std::runtime_error(boost::str(boost::format(message) % formatting_elems)) #define ASSERT_IF_CALLED_WITH_PLAYER if(!player) {logGlobal->errorStream() << BOOST_CURRENT_FUNCTION; assert(0);} //XXX pls dont - 'debug macros' are usually more trouble than it's worth #define HANDLE_EXCEPTION \ catch (const std::exception& e) { \ logGlobal->errorStream() << e.what(); \ throw; \ } \ catch (const std::exception * e) \ { \ logGlobal->errorStream() << e->what(); \ throw; \ } \ catch (const std::string& e) { \ logGlobal->errorStream() << e; \ throw; \ } #define HANDLE_EXCEPTIONC(COMMAND) \ catch (const std::exception& e) { \ COMMAND; \ logGlobal->errorStream() << e.what(); \ throw; \ } \ catch (const std::string &e) \ { \ COMMAND; \ logGlobal->errorStream() << e; \ throw; \ } // can be used for counting arrays template char (&_ArrayCountObj(const T (&)[N]))[N]; #define ARRAY_COUNT(arr) (sizeof(_ArrayCountObj(arr))) // should be used for variables that becomes unused in release builds (e.g. only used for assert checks) #define UNUSED(VAR) ((void)VAR) /* ---------------------------------------------------------------------------- */ /* VCMI standard library */ /* ---------------------------------------------------------------------------- */ #include "lib/logging/CLogger.h" void inline handleException() { try { throw; } catch(const std::exception & ex) { logGlobal->errorStream() << ex.what(); } catch(const std::string & ex) { logGlobal->errorStream() << ex; } catch(...) { logGlobal->errorStream() << "Sorry, caught unknown exception type. No more info available."; } } template std::ostream & operator<<(std::ostream & out, const boost::optional & opt) { if(opt) return out << *opt; else return out << "empty"; } template std::ostream & operator<<(std::ostream & out, const std::vector & container) { out << "["; for(auto it = container.begin(); it != container.end(); ++it) { out << *it; if(std::prev(container.end()) != it) out << ", "; } return out << "]"; } namespace vstd { // combine hashes. Present in boost but not in std template inline void hash_combine(std::size_t& seed, const T& v) { std::hash hasher; seed ^= hasher(v) + 0x9e3779b9 + (seed<<6) + (seed>>2); } //returns true if container c contains item i template bool contains(const Container & c, const Item &i) { return std::find(std::begin(c), std::end(c),i) != std::end(c); } //returns true if container c contains item i template bool contains_if(const Container & c, Pred p) { return std::find_if(std::begin(c), std::end(c), p) != std::end(c); } //returns true if map c contains item i template bool contains(const std::map & c, const Item2 &i) { return c.find(i)!=c.end(); } //returns true if unordered set c contains item i template bool contains(const std::unordered_set & c, const Item &i) { return c.find(i)!=c.end(); } template bool contains(const std::unordered_map & c, const Item2 &i) { return c.find(i)!=c.end(); } //returns position of first element in vector c equal to s, if there is no such element, -1 is returned template int find_pos(const Container & c, const T2 &s) { size_t i=0; for (auto iter = std::begin(c); iter != std::end(c); iter++, i++) if(*iter == s) return i; return -1; } //Func f tells if element matches template int find_pos_if(const Container & c, const Func &f) { auto ret = boost::range::find_if(c, f); if(ret != std::end(c)) return std::distance(std::begin(c), ret); return -1; } //returns iterator to the given element if present in container, end() if not template typename Container::iterator find(Container & c, const Item &i) { return std::find(c.begin(),c.end(),i); } //returns const iterator to the given element if present in container, end() if not template typename Container::const_iterator find(const Container & c, const Item &i) { return std::find(c.begin(),c.end(),i); } //removes element i from container c, returns false if c does not contain i template typename Container::size_type operator-=(Container &c, const Item &i) { typename Container::iterator itr = find(c,i); if(itr == c.end()) return false; c.erase(itr); return true; } //assigns greater of (a, b) to a and returns maximum of (a, b) template t1 &amax(t1 &a, const t2 &b) { if(a >= b) return a; else { a = b; return a; } } //assigns smaller of (a, b) to a and returns minimum of (a, b) template t1 &amin(t1 &a, const t2 &b) { if(a <= b) return a; else { a = b; return a; } } //makes a to fit the range template t1 &abetween(t1 &a, const t2 &b, const t3 &c) { amax(a,b); amin(a,c); return a; } //checks if a is between b and c template bool isbetween(const t1 &value, const t2 &min, const t3 &max) { return value > min && value < max; } //checks if a is within b and c template bool iswithin(const t1 &value, const t2 &min, const t3 &max) { return value >= min && value <= max; } template struct assigner { public: t1 &op1; t2 op2; assigner(t1 &a1, const t2 & a2) :op1(a1), op2(a2) {} void operator()() { op1 = op2; } }; // Assigns value a2 to a1. The point of time of the real operation can be controlled // with the () operator. template assigner assigno(t1 &a1, const t2 &a2) { return assigner(a1,a2); } //deleted pointer and sets it to nullptr template void clear_pointer(T* &ptr) { delete ptr; ptr = nullptr; } #if _MSC_VER >= 1800 using std::make_unique; #else template std::unique_ptr make_unique() { return std::unique_ptr(new T()); } template std::unique_ptr make_unique(Arg1 &&arg1) { return std::unique_ptr(new T(std::forward(arg1))); } template std::unique_ptr make_unique(Arg1 &&arg1, Arg2 &&arg2) { return std::unique_ptr(new T(std::forward(arg1), std::forward(arg2))); } template std::unique_ptr make_unique(Arg1 &&arg1, Arg2 &&arg2, Arg3 &&arg3) { return std::unique_ptr(new T(std::forward(arg1), std::forward(arg2), std::forward(arg3))); } template std::unique_ptr make_unique(Arg1 &&arg1, Arg2 &&arg2, Arg3 &&arg3, Arg4 &&arg4) { return std::unique_ptr(new T(std::forward(arg1), std::forward(arg2), std::forward(arg3), std::forward(arg4))); } #endif template typename Container::const_reference circularAt(const Container &r, size_t index) { assert(r.size()); index %= r.size(); auto itr = std::begin(r); std::advance(itr, index); return *itr; } template void erase_if(Range &vec, Predicate pred) { vec.erase(boost::remove_if(vec, pred),vec.end()); } template void erase_if(std::set &setContainer, Predicate pred) { auto itr = setContainer.begin(); auto endItr = setContainer.end(); while(itr != endItr) { auto tmpItr = itr++; if(pred(*tmpItr)) setContainer.erase(tmpItr); } } //works for map and std::map, maybe something else template void erase_if(std::map &container, Predicate pred) { auto itr = container.begin(); auto endItr = container.end(); while(itr != endItr) { auto tmpItr = itr++; if(pred(*tmpItr)) container.erase(tmpItr); } } template OutputIterator copy_if(const InputRange &input, OutputIterator result, Predicate pred) { return std::copy_if(boost::const_begin(input), std::end(input), result, pred); } template std::insert_iterator set_inserter(Container &c) { return std::inserter(c, c.end()); } //Returns iterator to the element for which the value of ValueFunction is minimal template auto minElementByFun(const ForwardRange& rng, ValueFunction vf) -> decltype(std::begin(rng)) { /* Clang crashes when instantiating this function template and having PCH compilation enabled. * There is a bug report here: http://llvm.org/bugs/show_bug.cgi?id=18744 * Current bugfix is to don't use a typedef for decltype(*std::begin(rng)) and to use decltype * directly for both function parameters. */ return boost::min_element(rng, [&] (decltype(*std::begin(rng)) lhs, decltype(*std::begin(rng)) rhs) -> bool { return vf(lhs) < vf(rhs); }); } //Returns iterator to the element for which the value of ValueFunction is maximal template auto maxElementByFun(const ForwardRange& rng, ValueFunction vf) -> decltype(std::begin(rng)) { /* Clang crashes when instantiating this function template and having PCH compilation enabled. * There is a bug report here: http://llvm.org/bugs/show_bug.cgi?id=18744 * Current bugfix is to don't use a typedef for decltype(*std::begin(rng)) and to use decltype * directly for both function parameters. */ return boost::max_element(rng, [&] (decltype(*std::begin(rng)) lhs, decltype(*std::begin(rng)) rhs) -> bool { return vf(lhs) < vf(rhs); }); } template void advance(T &obj, int change) { obj = (T)(((int)obj) + change); } template typename Container::value_type backOrNull(const Container &c) //returns last element of container or nullptr if it is empty (to be used with containers of pointers) { if(c.size()) return c.back(); else return typename Container::value_type(); } template typename Container::value_type frontOrNull(const Container &c) //returns first element of container or nullptr if it is empty (to be used with containers of pointers) { if(c.size()) return c.front(); else return nullptr; } template bool isValidIndex(const Container &c, Index i) { return i >= 0 && i < c.size(); } template boost::optional tryAt(const Container &c, Index i) { if(isValidIndex(c, i)) { auto itr = c.begin(); std::advance(itr, i); return *itr; } return boost::none; } template static boost::optional tryFindIf(const Container &r, const Pred &t) { auto pos = range::find_if(r, t); if(pos == boost::end(r)) return boost::none; else return *pos; } template typename Container::const_reference atOrDefault(const Container &r, size_t index, const typename Container::const_reference &defaultValue) { if(index < r.size()) return r[index]; return defaultValue; } template bool erase_if_present(Container &c, const Item &item) { auto i = std::find(c.begin(), c.end(), item); if (i != c.end()) { c.erase(i); return true; } return false; } template bool erase_if_present(std::map & c, const Item2 &item) { auto i = c.find(item); if (i != c.end()) { c.erase(i); return true; } return false; } template void erase(Container &c, Pred pred) { c.erase(boost::remove_if(c, pred), c.end()); } template void removeDuplicates(std::vector &vec) { boost::sort(vec); vec.erase(std::unique(vec.begin(), vec.end()), vec.end()); } template void concatenate(std::vector &dest, const std::vector &src) { dest.reserve(dest.size() + src.size()); dest.insert(dest.end(), src.begin(), src.end()); } using boost::math::round; } using vstd::operator-=; using vstd::make_unique;