Line data Source code
1 :
2 : /* Copyright (c) 2009-2014, Stefan Eilemann <eile@equalizergraphics.com>
3 : *
4 : * This file is part of Collage <https://github.com/Eyescale/Collage>
5 : *
6 : * This library is free software; you can redistribute it and/or modify it under
7 : * the terms of the GNU Lesser General Public License version 2.1 as published
8 : * by the Free Software Foundation.
9 : *
10 : * This library is distributed in the hope that it will be useful, but WITHOUT
11 : * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 : * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13 : * details.
14 : *
15 : * You should have received a copy of the GNU Lesser General Public License
16 : * along with this library; if not, write to the Free Software Foundation, Inc.,
17 : * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 : */
19 :
20 : #ifndef CO_OBJECTVERSION_H
21 : #define CO_OBJECTVERSION_H
22 :
23 : #include <co/api.h>
24 : #include <co/types.h>
25 : #include <lunchbox/bitOperation.h>
26 : #include <lunchbox/stdExt.h>
27 : #include <iostream>
28 :
29 : namespace co
30 : {
31 : /** Special object version values */
32 940 : static const uint128_t VERSION_NONE( 0, 0 );
33 940 : static const uint128_t VERSION_FIRST( 0, 1 );
34 940 : static const uint128_t VERSION_NEWEST( 0, 0xfffffffffffffffbull );
35 940 : static const uint128_t VERSION_OLDEST( 0, 0xfffffffffffffffcull );
36 940 : static const uint128_t VERSION_NEXT( 0, 0xfffffffffffffffdull );
37 940 : static const uint128_t VERSION_INVALID( 0, 0xfffffffffffffffeull );
38 940 : static const uint128_t VERSION_HEAD( 0, 0xffffffffffffffffull );
39 :
40 : /**
41 : * A helper struct bundling an object identifier and version.
42 : *
43 : * Primarily used for serialization. The struct either contains the object's
44 : * identifier and version (if it is registered or mapped), 0 and VERSION_NONE if
45 : * it is unmapped or if no object was given.
46 : */
47 1 : struct ObjectVersion
48 : {
49 : /** Construct a new, zero-initialized object version. @version 1.0 */
50 : CO_API ObjectVersion();
51 :
52 : /** Construct a new object version. @version 1.0 */
53 : CO_API ObjectVersion( const uint128_t& identifier,
54 : const uint128_t& version );
55 :
56 : /** Construct a new object version. @version 1.0 */
57 : CO_API explicit ObjectVersion( const Object* object );
58 :
59 : /** Construct a new object version. @version 1.2 */
60 : CO_API explicit ObjectVersion( const Object& object );
61 :
62 : /** Construct a new object version. @version 1.0 */
63 : template< class R > explicit ObjectVersion( lunchbox::RefPtr< R > object )
64 : { *this = object.get(); }
65 :
66 : /** Assign a new identifier and version. @version 1.0 */
67 : CO_API ObjectVersion& operator = ( const Object* object );
68 :
69 : /** @return true if both structs contain the same values. @version 1.0 */
70 : bool operator == ( const ObjectVersion& value ) const
71 : {
72 : return ( identifier == value.identifier &&
73 : version == value.version );
74 : }
75 :
76 : /** @return true if both structs have different values. @version 1.0 */
77 1 : bool operator != ( const ObjectVersion& value ) const
78 : {
79 2 : return ( identifier != value.identifier ||
80 2 : version != value.version );
81 : }
82 :
83 : bool operator < ( const ObjectVersion& rhs ) const //!< @internal
84 : {
85 : return identifier < rhs.identifier ||
86 : ( identifier == rhs.identifier && version < rhs.version );
87 : }
88 :
89 : bool operator > ( const ObjectVersion& rhs ) const //!< @internal
90 : {
91 : return identifier > rhs.identifier ||
92 : ( identifier == rhs.identifier && version > rhs.version );
93 : }
94 :
95 : uint128_t identifier; //!< the object identifier
96 : uint128_t version; //!< the object version
97 : };
98 :
99 0 : inline std::ostream& operator << (std::ostream& os, const ObjectVersion& ov)
100 0 : { return os << "id " << ov.identifier << " v" << ov.version; }
101 : }
102 :
103 : namespace lunchbox
104 : {
105 0 : template<> inline void byteswap( co::ObjectVersion& value ) //!< @internal
106 : {
107 0 : lunchbox::byteswap( value.identifier );
108 0 : lunchbox::byteswap( value.version );
109 0 : }
110 : }
111 :
112 : LB_STDEXT_NAMESPACE_OPEN
113 : #ifdef LB_STDEXT_MSVC
114 : /** ObjectVersion hash function. */
115 : template<>
116 : inline size_t hash_compare< co::ObjectVersion >::operator()
117 : ( const co::ObjectVersion& key ) const
118 : {
119 : const size_t hashVersion = hash_value( key.version );
120 : const size_t hashID = hash_value( key.identifier );
121 :
122 : return hash_value( hashVersion ^ hashID );
123 : }
124 : #else
125 : /** ObjectVersion hash function. */
126 : template<> struct hash< co::ObjectVersion >
127 : {
128 : template< typename P > size_t operator()( const P& key ) const
129 : {
130 : return hash< uint64_t >()( hash_value( key.version ) ^
131 : hash_value( key.identifier ));
132 : }
133 : };
134 : #endif
135 : LB_STDEXT_NAMESPACE_CLOSE
136 :
137 : #endif // CO_OBJECT_H
|
