Add AsProblem to report non-critical problems with data

1 files changed, 123 insertions, 0 deletions

diff --git a/libappstream-glib/as-problem.h b/libappstream-glib/as-problem.h
new file mode 100644
index 0000000..9f59352
--- /dev/null
+++ b/libappstream-glib/as-problem.h
@@ -0,0 +1,123 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2014 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_PROBLEM_H
+#define __AS_PROBLEM_H
+
+#include <glib-object.h>
+
+#define AS_TYPE_PROBLEM			(as_problem_get_type())
+#define AS_PROBLEM(obj)			(G_TYPE_CHECK_INSTANCE_CAST((obj), AS_TYPE_PROBLEM, AsProblem))
+#define AS_PROBLEM_CLASS(cls)		(G_TYPE_CHECK_CLASS_CAST((cls), AS_TYPE_PROBLEM, AsProblemClass))
+#define AS_IS_PROBLEM(obj)		(G_TYPE_CHECK_INSTANCE_TYPE((obj), AS_TYPE_PROBLEM))
+#define AS_IS_PROBLEM_CLASS(cls)	(G_TYPE_CHECK_CLASS_TYPE((cls), AS_TYPE_PROBLEM))
+#define AS_PROBLEM_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS((obj), AS_TYPE_PROBLEM, AsProblemClass))
+
+G_BEGIN_DECLS
+
+typedef struct _AsProblem		AsProblem;
+typedef struct _AsProblemClass		AsProblemClass;
+
+struct _AsProblem
+{
+	GObject			parent;
+};
+
+struct _AsProblemClass
+{
+	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);
+};
+
+/**
+ * AsProblemKind:
+ * @AS_PROBLEM_KIND_UNKNOWN:			Type invalid or not known
+ * @AS_PROBLEM_KIND_TAG_DUPLICATED:		A tag is duplicated
+ * @AS_PROBLEM_KIND_TAG_MISSING:		A required tag is missing
+ * @AS_PROBLEM_KIND_TAG_INVALID:		A tag value is invalid
+ * @AS_PROBLEM_KIND_ATTRIBUTE_MISSING:		A required attribute is missing
+ * @AS_PROBLEM_KIND_ATTRIBUTE_INVALID:		An attribute is invalid
+ * @AS_PROBLEM_KIND_MARKUP_INVALID:		The XML markup is invalid
+ * @AS_PROBLEM_KIND_STYLE_INCORRECT:		Style guidelines are incorrect
+ * @AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED:	Translations are required
+ * @AS_PROBLEM_KIND_DUPLICATE_DATA:		Some data is duplicated
+ * @AS_PROBLEM_KIND_VALUE_MISSING:		A value is required
+ * @AS_PROBLEM_KIND_URL_NOT_FOUND:		The URL is not found
+ * @AS_PROBLEM_KIND_FILE_INVALID:		The file is invalid
+ * @AS_PROBLEM_KIND_ASPECT_RATIO_INCORRECT:	The image aspect ratio is wrong
+ * @AS_PROBLEM_KIND_RESOLUTION_INCORRECT:	The image resolution is wrong
+ *
+ * The problem type.
+ **/
+typedef enum {
+	AS_PROBLEM_KIND_UNKNOWN,
+	AS_PROBLEM_KIND_TAG_DUPLICATED,
+	AS_PROBLEM_KIND_TAG_MISSING,
+	AS_PROBLEM_KIND_TAG_INVALID,
+	AS_PROBLEM_KIND_ATTRIBUTE_MISSING,
+	AS_PROBLEM_KIND_ATTRIBUTE_INVALID,
+	AS_PROBLEM_KIND_MARKUP_INVALID,
+	AS_PROBLEM_KIND_STYLE_INCORRECT,
+	AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED,
+	AS_PROBLEM_KIND_DUPLICATE_DATA,
+	AS_PROBLEM_KIND_VALUE_MISSING,
+	AS_PROBLEM_KIND_URL_NOT_FOUND,
+	AS_PROBLEM_KIND_FILE_INVALID,
+	AS_PROBLEM_KIND_ASPECT_RATIO_INCORRECT,
+	AS_PROBLEM_KIND_RESOLUTION_INCORRECT,
+	/*< private >*/
+	AS_PROBLEM_KIND_LAST
+} AsProblemKind;
+
+GType		 as_problem_get_type		(void);
+AsProblem	*as_problem_new			(void);
+
+/* helpers */
+const gchar	*as_problem_kind_to_string	(AsProblemKind	 kind);
+
+/* getters */
+AsProblemKind	 as_problem_get_kind		(AsProblem	*problem);
+guint		 as_problem_get_line_number	(AsProblem	*problem);
+const gchar	*as_problem_get_message		(AsProblem	*problem);
+
+/* setters */
+void		 as_problem_set_kind		(AsProblem	*problem,
+						 AsProblemKind	 kind);
+void		 as_problem_set_line_number	(AsProblem	*problem,
+						 guint		 line_number);
+void		 as_problem_set_message		(AsProblem	*problem,
+						 const gchar	*message);
+
+G_END_DECLS
+
+#endif /* __AS_PROBLEM_H */