keybuk@google.com | bf4649a | 2012-02-15 06:29:06 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 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 DBUS_OBJECT_PATH_H_ |
| 6 | #define DBUS_OBJECT_PATH_H_ |
| 7 | #pragma once |
| 8 | |
| 9 | #include <string> |
| 10 | |
| 11 | namespace dbus { |
| 12 | |
| 13 | // ObjectPath is a type used to distinguish D-Bus object paths from simple |
| 14 | // strings, especially since normal practice is that these should be only |
| 15 | // initialized from static constants or obtained from remote objects and no |
| 16 | // assumptions about their value made. |
| 17 | class ObjectPath { |
| 18 | public: |
| 19 | // Permit initialization without a value for passing to |
| 20 | // dbus::MessageReader::PopObjectPath to fill in and from std::string |
| 21 | // objects. |
| 22 | // |
| 23 | // The compiler synthesised copy constructor and assignment operator are |
| 24 | // sufficient for our needs, as is implicit initialization of a std::string |
| 25 | // from a string constant. |
| 26 | ObjectPath() {} |
| 27 | explicit ObjectPath(const std::string& value) : value_(value) {} |
| 28 | |
| 29 | // Retrieves value as a std::string. |
| 30 | const std::string& value() const { return value_; } |
| 31 | |
| 32 | // Permit sufficient comparison to allow an ObjectPath to be used as a |
| 33 | // key in a std::map. |
| 34 | bool operator<(const ObjectPath&) const; |
| 35 | |
| 36 | // Permit testing for equality, required for mocks to work and useful for |
| 37 | // observers. |
| 38 | bool operator==(const ObjectPath&) const; |
| 39 | bool operator!=(const ObjectPath&) const; |
| 40 | private: |
| 41 | std::string value_; |
| 42 | }; |
| 43 | |
| 44 | } // namespace dbus |
| 45 | |
| 46 | #endif // DBUS_OBJECT_PATH_H_ |