1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- 2 * 3 * Copyright (C) 2014 Richard Hughes <richard@hughsie.com> 4 * 5 * SPDX-License-Identifier: LGPL-2.1+ 6 */ 7 8 #pragma once 9 10 #if !defined (__APPSTREAM_GLIB_H_INSIDE__) && !defined (AS_COMPILATION) 11 #error "Only <appstream-glib.h> can be included directly." 12 #endif 13 14 #include <glib-object.h> 15 16 G_BEGIN_DECLS 17 18 #define AS_TYPE_PROBLEM (as_problem_get_type ()) 19 G_DECLARE_DERIVABLE_TYPE (AsProblem, as_problem, AS, PROBLEM, GObject) 20 21 struct _AsProblemClass 22 { 23 GObjectClass parent_class; 24 /*< private >*/ 25 void (*_as_reserved1) (void); 26 void (*_as_reserved2) (void); 27 void (*_as_reserved3) (void); 28 void (*_as_reserved4) (void); 29 void (*_as_reserved5) (void); 30 void (*_as_reserved6) (void); 31 void (*_as_reserved7) (void); 32 void (*_as_reserved8) (void); 33 }; 34 35 /** 36 * AsProblemKind: 37 * @AS_PROBLEM_KIND_UNKNOWN: Type invalid or not known 38 * @AS_PROBLEM_KIND_TAG_DUPLICATED: A tag is duplicated 39 * @AS_PROBLEM_KIND_TAG_MISSING: A required tag is missing 40 * @AS_PROBLEM_KIND_TAG_INVALID: A tag value is invalid 41 * @AS_PROBLEM_KIND_ATTRIBUTE_MISSING: A required attribute is missing 42 * @AS_PROBLEM_KIND_ATTRIBUTE_INVALID: An attribute is invalid 43 * @AS_PROBLEM_KIND_MARKUP_INVALID: The XML markup is invalid 44 * @AS_PROBLEM_KIND_STYLE_INCORRECT: Style guidelines are incorrect 45 * @AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED: Translations are required 46 * @AS_PROBLEM_KIND_DUPLICATE_DATA: Some data is duplicated 47 * @AS_PROBLEM_KIND_VALUE_MISSING: A value is required 48 * @AS_PROBLEM_KIND_URL_NOT_FOUND: The URL is not found 49 * @AS_PROBLEM_KIND_FILE_INVALID: The file is invalid 50 * @AS_PROBLEM_KIND_ASPECT_RATIO_INCORRECT: The image aspect ratio is wrong 51 * @AS_PROBLEM_KIND_RESOLUTION_INCORRECT: The image resolution is wrong 52 * 53 * The problem type. 54 **/ 55 typedef enum { 56 AS_PROBLEM_KIND_UNKNOWN, 57 AS_PROBLEM_KIND_TAG_DUPLICATED, 58 AS_PROBLEM_KIND_TAG_MISSING, 59 AS_PROBLEM_KIND_TAG_INVALID, 60 AS_PROBLEM_KIND_ATTRIBUTE_MISSING, 61 AS_PROBLEM_KIND_ATTRIBUTE_INVALID, 62 AS_PROBLEM_KIND_MARKUP_INVALID, 63 AS_PROBLEM_KIND_STYLE_INCORRECT, 64 AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED, 65 AS_PROBLEM_KIND_DUPLICATE_DATA, 66 AS_PROBLEM_KIND_VALUE_MISSING, 67 AS_PROBLEM_KIND_URL_NOT_FOUND, 68 AS_PROBLEM_KIND_FILE_INVALID, 69 AS_PROBLEM_KIND_ASPECT_RATIO_INCORRECT, 70 AS_PROBLEM_KIND_RESOLUTION_INCORRECT, 71 /*< private >*/ 72 AS_PROBLEM_KIND_LAST 73 } AsProblemKind; 74 75 AsProblem *as_problem_new (void); 76 77 /* helpers */ 78 const gchar *as_problem_kind_to_string (AsProblemKind kind); 79 80 /* getters */ 81 AsProblemKind as_problem_get_kind (AsProblem *problem); 82 guint as_problem_get_line_number (AsProblem *problem); 83 const gchar *as_problem_get_message (AsProblem *problem); 84 85 /* setters */ 86 void as_problem_set_kind (AsProblem *problem, 87 AsProblemKind kind); 88 void as_problem_set_line_number (AsProblem *problem, 89 guint line_number); 90 void as_problem_set_message (AsProblem *problem, 91 const gchar *message); 92 93 G_END_DECLS 94