1
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited
9 // Copyright (c) 2014-2018 Francois Beaune, The appleseedhq Organization
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining a copy
12 // of this software and associated documentation files (the "Software"), to deal
13 // in the Software without restriction, including without limitation the rights
14 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 // copies of the Software, and to permit persons to whom the Software is
16 // furnished to do so, subject to the following conditions:
17 //
18 // The above copyright notice and this permission notice shall be included in
19 // all copies or substantial portions of the Software.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 // THE SOFTWARE.
28 //
29
30 #pragma once
31
32 // appleseed.foundation headers.
33 #include "foundation/core/concepts/noncopyable.h"
34 #include "foundation/platform/types.h"
35
36 // appleseed.main headers.
37 #include "main/dllsymbol.h"
38
39 namespace foundation
40 {
41
42 //
43 // A unique identifier.
44 //
45
46 typedef uint64 UniqueID;
47
48
49 //
50 // Format string for printing unique identifiers to strings.
51 //
52
53 #define FMT_UNIQUE_ID FMT_UINT64
54
55
56 //
57 // Base class for uniquely identifiable objects.
58 //
59
60 class APPLESEED_DLLSYMBOL Identifiable
61 : public NonCopyable
62 {
63 public:
64 // Constructor, assigns a unique ID to this instance.
65 Identifiable();
66
67 // Return the unique ID of this object.
68 UniqueID get_uid() const;
69
70 private:
71 const UniqueID m_unique_id;
72 };
73
74
75 //
76 // This function generates identifiers that are unique within the process.
77 //
78 // Thread-safe.
79 //
80
81 APPLESEED_DLLSYMBOL UniqueID new_guid();
82
83
84 //
85 // Identifiable class implementation.
86 //
87
Identifiable()88 inline Identifiable::Identifiable()
89 : m_unique_id(new_guid())
90 {
91 }
92
get_uid()93 inline UniqueID Identifiable::get_uid() const
94 {
95 return m_unique_id;
96 }
97
98 } // namespace foundation
99