summaryrefslogtreecommitdiffstats
path: root/src/tqdbusobjectpath.h
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2019-04-27 00:21:43 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2019-04-27 00:21:43 +0900
commitf9c9e15267bd0319a8190ba146d7be95c37dac2e (patch)
tree1180022eddef0ffc8f44b030e721b6efef4f8b2a /src/tqdbusobjectpath.h
parent7d3c2ed4e8cdf9292059a4fc8f3678ca9d1d7c5c (diff)
downloaddbus-1-tqt-f9c9e15267bd0319a8190ba146d7be95c37dac2e.tar.gz
dbus-1-tqt-f9c9e15267bd0319a8190ba146d7be95c37dac2e.zip
Moved source files to "src" folder.
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'src/tqdbusobjectpath.h')
-rw-r--r--src/tqdbusobjectpath.h119
1 files changed, 119 insertions, 0 deletions
diff --git a/src/tqdbusobjectpath.h b/src/tqdbusobjectpath.h
new file mode 100644
index 0000000..7a166c6
--- /dev/null
+++ b/src/tqdbusobjectpath.h
@@ -0,0 +1,119 @@
+/* qdbusobjectpath.h DBUS object path data type
+ *
+ * Copyright (C) 2007 Kevin Krammer <kevin.krammer@gmx.at>
+ *
+ * Licensed under the Academic Free License version 2.1
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA.
+ *
+ */
+
+#ifndef TQDBUSOBJECTPATH_H
+#define TQDBUSOBJECTPATH_H
+
+#include <tqcstring.h>
+#include "tqdbusmacros.h"
+
+/**
+ * @brief Class for representing D-Bus object paths
+ *
+ * This data type is necessary to correctly represent object paths in the
+ * context of D-Bus messages, since normal strings have a different D-Bus
+ * signature than object paths.
+ *
+ * @see @ref dbusconventions-objectpath
+ */
+class TQDBUS_EXPORT TQT_DBusObjectPath : public TQCString
+{
+public:
+ /**
+ * @brief Creates an empty and invalid object path
+ */
+ TQT_DBusObjectPath();
+
+ /**
+ * @brief Creates copy of the given @p other object path
+ *
+ * @param other the object path to copy
+ */
+ TQT_DBusObjectPath(const TQT_DBusObjectPath& other);
+
+ /**
+ * @brief Creates copy of the given @p other object path
+ *
+ * @param other the object path to copy
+ */
+ TQT_DBusObjectPath(const TQCString& other);
+
+ /**
+ * @brief Creates an object path for an object as a child of the parent node
+ *
+ * This is basically like specifying a directory and a file name to create
+ * the file's full path.
+ *
+ * Example:
+ * @code
+ * TQT_DBusObjectPath rootNode("/"); // => "/"
+ *
+ * TQT_DBusObjectPath childNod(rootNode, "child"); // => "/child"
+ *
+ * TQT_DBusObjectPath grandChildNode(childNode, "grandchild"); // => "/child/grandchild"
+ * @endcode
+ *
+ * @param parentNode the object path to create the child on
+ * @param nodeName the name of the child node
+ */
+ TQT_DBusObjectPath(const TQT_DBusObjectPath& parentNode, const TQCString& nodeName);
+
+ /**
+ * @brief Returns whether the current content is considered a valid object path
+ *
+ * @note Calls validate() to perform a check on the current content
+ *
+ * @return \c true if the object's content describe a valid object path,
+ * otherwise @c false
+ *
+ * @see @ref dbusconventions-objectpath
+ */
+ bool isValid() const;
+
+ /**
+ * @brief Returns the object path of this path's parent node
+ *
+ * This is basically like getting the directory of an file path
+ *
+ * @return the parent node's object path or an empty and invalid object
+ * if this is already the root node
+ */
+ TQT_DBusObjectPath parentNode() const;
+
+ /**
+ * @brief Checks the given string for validity as a D-Bus object path
+ *
+ * See section @ref dbusconventions-objectpath for information on object
+ * path formatting.
+ *
+ * @param path the string to check
+ *
+ * @return @c -1 if the object path is valid, otherwise the index of the
+ * first violating character
+ *
+ * @see isValid()
+ */
+ static int validate(const TQCString& path);
+};
+
+#endif