1
2//
3// This source file is part of appleseed.
4// Visit http://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-2017 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#ifndef APPLESEED_FOUNDATION_UTILITY_UID_H
31#define APPLESEED_FOUNDATION_UTILITY_UID_H
32
33// appleseed.foundation headers.
34#include "foundation/core/concepts/noncopyable.h"
35#include "foundation/platform/types.h"
36
37// appleseed.main headers.
38#include "main/dllsymbol.h"
39
40namespace foundation
41{
42
43//
44// A unique identifier.
45//
46
47typedef uint64 UniqueID;
48
49
50//
51// Format string for printing unique identifiers to strings.
52//
53
54#define FMT_UNIQUE_ID FMT_UINT64
55
56
57//
58// Base class for uniquely identifiable objects.
59//
60
61class APPLESEED_DLLSYMBOL Identifiable
62 : public NonCopyable
63{
64 public:
65 // Constructor, assigns a unique ID to this instance.
66 Identifiable();
67
68 // Return the unique ID of this object.
69 UniqueID get_uid() const;
70
71 private:
72 const UniqueID m_unique_id;
73};
74
75
76//
77// This function generates identifiers that are unique within the process.
78//
79// Thread-safe.
80//
81
82APPLESEED_DLLSYMBOL UniqueID new_guid();
83
84
85//
86// Identifiable class implementation.
87//
88
89inline Identifiable::Identifiable()
90 : m_unique_id(new_guid())
91{
92}
93
94inline UniqueID Identifiable::get_uid() const
95{
96 return m_unique_id;
97}
98
99} // namespace foundation
100
101#endif // !APPLESEED_FOUNDATION_UTILITY_UID_H
102