dbus/object_path.h

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