Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(248)

Side by Side Diff: content/common/id_type.h

Issue 1548443002: Introducing gpu::CommandBufferId as a distinct, IdType<...>-based type. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@type-safe-save-package-id-self-contained
Patch Set: Rebasing... Created 4 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « content/common/gpu/gpu_command_buffer_stub.cc ('k') | content/common/id_type_unittest.cc » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 // Copyright 2016 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef CONTENT_COMMON_ID_TYPE_H_
6 #define CONTENT_COMMON_ID_TYPE_H_
7
8 #include <stdint.h>
9 #include <cstddef>
10 #include <ostream>
11 #include <type_traits>
12
13 // IdType32<>, IdType64<>, etc. wrap an integer id in a custom, type-safe type.
14 //
15 // IdType32<Foo> is an alternative to int, for a class Foo with methods like:
16 //
17 // int GetId() { return id_; };
18 // static Foo* FromId(int id) { return g_all_foos_by_id[id]; }
19 //
20 // Such methods are a standard means of safely referring to objects across
21 // thread and process boundaries. But if a nearby class Bar also represents
22 // its IDs as a bare int, horrific mixups are possible -- one example, of many,
23 // is http://crrev.com/365437. IdType<> offers compile-time protection against
24 // such mishaps, since IdType32<Foo> is incompatible with IdType32<Bar>, even
25 // though both just compile down to an int32_t.
26 //
27 // Templates in this file:
28 // IdType32<T> / IdTypeU32<T>: Signed / unsigned 32-bit IDs
29 // IdType64<T> / IdTypeU64<T>: Signed / unsigned 64-bit IDs
30 // IdType<>: For when you need a different underlying type or
31 // a default/invalid value other than zero.
32 //
33 // IdType32<Foo> behaves just like an int32_t in the following aspects:
34 // - it can be used as a key in std::map and/or std::unordered_map;
35 // - it can be used as an argument to DCHECK_EQ or streamed to LOG(ERROR);
36 // - it has the same memory footprint and runtime overhead as int32_t;
37 // - it can be copied by memcpy.
38 //
39 // IdType32<Foo> has the following differences from a bare int32_t:
40 // - it forces coercions to go through GetUnsafeValue and FromUnsafeValue;
41 // - it restricts the set of available operations (i.e. no multiplication);
42 // - it ensures initialization to zero and allows checking against
43 // default-initialized values via is_null method.
44
45 namespace content {
46
47 template <typename TypeMarker, typename WrappedType, WrappedType kInvalidValue>
48 class IdType {
49 public:
50 IdType() : value_(kInvalidValue) {}
51 bool is_null() const { return value_ == kInvalidValue; }
52
53 static IdType FromUnsafeValue(WrappedType value) { return IdType(value); }
54 WrappedType GetUnsafeValue() const { return value_; }
55
56 IdType(const IdType& other) = default;
57 IdType& operator=(const IdType& other) = default;
58
59 bool operator==(const IdType& other) const { return value_ == other.value_; }
60 bool operator!=(const IdType& other) const { return value_ != other.value_; }
61 bool operator<(const IdType& other) const { return value_ < other.value_; }
62
63 // Hasher to use in std::unordered_map, std::unordered_set, etc.
64 struct Hasher {
65 using argument_type = IdType;
66 using result_type = std::size_t;
67 result_type operator()(const argument_type& id) const {
68 return std::hash<WrappedType>()(id.GetUnsafeValue());
69 }
70 };
71
72 protected:
73 explicit IdType(WrappedType val) : value_(val) {}
74
75 private:
76 // In theory WrappedType could be any type that supports ==, <, <<, std::hash,
77 // etc., but to make things simpler (both for users and for maintainers) we
78 // explicitly restrict the design space to integers. This means the users
79 // can safely assume that IdType is relatively small and cheap to copy
80 // and the maintainers don't have to worry about WrappedType being a complex
81 // type (i.e. std::string or std::pair or a move-only type).
82 using IntegralWrappedType =
83 typename std::enable_if<std::is_integral<WrappedType>::value,
84 WrappedType>::type;
85 IntegralWrappedType value_;
86 };
87
88 // Type aliases for convenience:
89 template <typename TypeMarker>
90 using IdType32 = IdType<TypeMarker, int32_t, 0>;
91 template <typename TypeMarker>
92 using IdTypeU32 = IdType<TypeMarker, uint32_t, 0>;
93 template <typename TypeMarker>
94 using IdType64 = IdType<TypeMarker, int64_t, 0>;
95 template <typename TypeMarker>
96 using IdTypeU64 = IdType<TypeMarker, uint64_t, 0>;
97
98 template <typename TypeMarker, typename WrappedType, WrappedType kInvalidValue>
99 std::ostream& operator<<(
100 std::ostream& stream,
101 const IdType<TypeMarker, WrappedType, kInvalidValue>& id) {
102 return stream << id.GetUnsafeValue();
103 }
104
105 } // namespace content
106
107 #endif // CONTENT_COMMON_ID_TYPE_H_
OLDNEW
« no previous file with comments | « content/common/gpu/gpu_command_buffer_stub.cc ('k') | content/common/id_type_unittest.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698