summaryrefslogtreecommitdiffstats
path: root/dbus/object_path.h
diff options
context:
space:
mode:
Diffstat (limited to 'dbus/object_path.h')
-rw-r--r--dbus/object_path.h46
1 files changed, 46 insertions, 0 deletions
diff --git a/dbus/object_path.h b/dbus/object_path.h
new file mode 100644
index 0000000..59071da
--- /dev/null
+++ b/dbus/object_path.h
@@ -0,0 +1,46 @@
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef DBUS_OBJECT_PATH_H_
+#define DBUS_OBJECT_PATH_H_
+#pragma once
+
+#include <string>
+
+namespace dbus {
+
+// ObjectPath is a type used to distinguish D-Bus object paths from simple
+// strings, especially since normal practice is that these should be only
+// initialized from static constants or obtained from remote objects and no
+// assumptions about their value made.
+class ObjectPath {
+ public:
+ // Permit initialization without a value for passing to
+ // dbus::MessageReader::PopObjectPath to fill in and from std::string
+ // objects.
+ //
+ // The compiler synthesised copy constructor and assignment operator are
+ // sufficient for our needs, as is implicit initialization of a std::string
+ // from a string constant.
+ ObjectPath() {}
+ explicit ObjectPath(const std::string& value) : value_(value) {}
+
+ // Retrieves value as a std::string.
+ const std::string& value() const { return value_; }
+
+ // Permit sufficient comparison to allow an ObjectPath to be used as a
+ // key in a std::map.
+ bool operator<(const ObjectPath&) const;
+
+ // Permit testing for equality, required for mocks to work and useful for
+ // observers.
+ bool operator==(const ObjectPath&) const;
+ bool operator!=(const ObjectPath&) const;
+ private:
+ std::string value_;
+};
+
+} // namespace dbus
+
+#endif // DBUS_OBJECT_PATH_H_