Add AsReviewwip/hughsie/AsReview

This allows us to represent an end-user application review.

1 files changed, 124 insertions, 0 deletions

diff --git a/libappstream-glib/as-review.h b/libappstream-glib/as-review.h
new file mode 100644
index 0000000..3b3b5f9
--- /dev/null
+++ b/libappstream-glib/as-review.h
@@ -0,0 +1,124 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2016 Canonical Ltd.
+ * Copyright (C) 2016 Richard Hughes <richard@hughsie.com>
+ *
+ * Licensed under the GNU Lesser General Public License Version 2.1
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+#if !defined (__APPSTREAM_GLIB_H) && !defined (AS_COMPILATION)
+#error "Only <appstream-glib.h> can be included directly."
+#endif
+
+#ifndef __AS_REVIEW_H
+#define __AS_REVIEW_H
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define AS_TYPE_REVIEW (as_review_get_type ())
+G_DECLARE_DERIVABLE_TYPE (AsReview, as_review, AS, REVIEW, GObject)
+
+struct _AsReviewClass
+{
+	GObjectClass		parent_class;
+	/*< private >*/
+	void (*_as_reserved1)	(void);
+	void (*_as_reserved2)	(void);
+	void (*_as_reserved3)	(void);
+	void (*_as_reserved4)	(void);
+	void (*_as_reserved5)	(void);
+	void (*_as_reserved6)	(void);
+	void (*_as_reserved7)	(void);
+	void (*_as_reserved8)	(void);
+};
+
+/**
+ * AsReviewFlags:
+ * @AS_REVIEW_FLAG_NONE:	No special flags set
+ * @AS_REVIEW_FLAG_SELF:	The user wrote the review themselves
+ * @AS_REVIEW_FLAG_VOTED:	The user voted on the review
+ *
+ * The flags for the review.
+ *
+ * Since: 0.5.18
+ **/
+typedef enum {
+	AS_REVIEW_FLAG_NONE	= 0,
+	AS_REVIEW_FLAG_SELF	= 1 << 0,
+	AS_REVIEW_FLAG_VOTED	= 1 << 1,
+	/*< private >*/
+	AS_REVIEW_FLAG_LAST
+} AsReviewFlags;
+
+AsReview	*as_review_new			(void);
+
+/* getters */
+gint		 as_review_get_karma		(AsReview	*review);
+gint		 as_review_get_score		(AsReview	*review);
+const gchar	*as_review_get_id		(AsReview	*review);
+const gchar	*as_review_get_summary		(AsReview	*review);
+const gchar	*as_review_get_description	(AsReview	*review);
+const gchar	*as_review_get_locale		(AsReview	*review);
+gint		 as_review_get_rating		(AsReview	*review);
+const gchar	*as_review_get_version		(AsReview	*review);
+const gchar	*as_review_get_reviewer_id	(AsReview	*review);
+const gchar	*as_review_get_reviewer_name	(AsReview	*review);
+GDateTime	*as_review_get_date		(AsReview	*review);
+AsReviewFlags	 as_review_get_flags		(AsReview	*review);
+const gchar	*as_review_get_metadata_item	(AsReview	*review,
+						 const gchar	*key);
+
+/* setters */
+void		 as_review_set_karma		(AsReview	*review,
+						 gint		 karma);
+void		 as_review_set_score		(AsReview	*review,
+						 gint		 score);
+void		 as_review_set_id		(AsReview	*review,
+						 const gchar	*id);
+void		 as_review_set_summary		(AsReview	*review,
+						 const gchar	*summary);
+void		 as_review_set_description	(AsReview	*review,
+						 const gchar	*description);
+void		 as_review_set_locale		(AsReview	*review,
+						 const gchar	*locale);
+void		 as_review_set_rating		(AsReview	*review,
+						 gint		 rating);
+void		 as_review_set_version		(AsReview	*review,
+						 const gchar	*version);
+void		 as_review_set_reviewer_id	(AsReview	*review,
+						 const gchar	*reviewer_id);
+void		 as_review_set_reviewer_name	(AsReview	*review,
+						 const gchar	*reviewer_name);
+void		 as_review_set_date		(AsReview	*review,
+						 GDateTime	*date);
+void		 as_review_set_flags		(AsReview	*review,
+						 AsReviewFlags	 flags);
+void		 as_review_add_flags		(AsReview	*review,
+						 AsReviewFlags	 flags);
+void		 as_review_add_metadata		(AsReview	*review,
+						 const gchar	*key,
+						 const gchar	*value);
+
+/* helpers */
+gboolean	 as_review_equal		(AsReview	*review1,
+						 AsReview	*review2);
+
+G_END_DECLS
+
+#endif /* __AS_REVIEW_H */