Debian Codegraph @

lib/packagekit-glib2/pk-package-sack.h

raw
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
2 *
3 * Copyright (C) 2009 Richard Hughes <[email protected]>
4 *
5 * Licensed under the GNU Lesser General Public License Version 2.1
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #if !defined (__PACKAGEKIT_H_INSIDE__) && !defined (PK_COMPILATION)
23 #error "Only <packagekit.h> can be included directly."
24 #endif
25
26 #ifndef __PK_PACKAGE_SACK_H
27 #define __PK_PACKAGE_SACK_H
28
29 #include <glib-object.h>
30 #include <gio/gio.h>
31 #include <packagekit-glib2/pk-progress.h>
32 #include <packagekit-glib2/pk-package.h>
33
34 G_BEGIN_DECLS
35
36 #define PK_TYPE_PACKAGE_SACK (pk_package_sack_get_type ())
37 #define PK_PACKAGE_SACK(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), PK_TYPE_PACKAGE_SACK, PkPackageSack))
38 #define PK_PACKAGE_SACK_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), PK_TYPE_PACKAGE_SACK, PkPackageSackClass))
39 #define PK_IS_PACKAGE_SACK(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), PK_TYPE_PACKAGE_SACK))
40 #define PK_IS_PACKAGE_SACK_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), PK_TYPE_PACKAGE_SACK))
41 #define PK_PACKAGE_SACK_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), PK_TYPE_PACKAGE_SACK, PkPackageSackClass))
42 #define PK_PACKAGE_SACK_TYPE_ERROR (pk_package_sack_error_get_type ())
43
44 typedef struct _PkPackageSackPrivate PkPackageSackPrivate;
45 typedef struct _PkPackageSack PkPackageSack;
46 typedef struct _PkPackageSackClass PkPackageSackClass;
47 typedef struct _PkPackageSackResults PkPackageSackResults;
48
49 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
50 G_DEFINE_AUTOPTR_CLEANUP_FUNC(PkPackageSack, g_object_unref)
51 #endif
52
53 struct _PkPackageSack
54 {
55 GObject parent;
56 PkPackageSackPrivate *priv;
57 };
58
59 struct _PkPackageSackClass
60 {
61 GObjectClass parent_class;
62
63 /* signals */
64 void (* changed) (PkPackageSack *sack);
65 /* padding for future expansion */
66 void (*_pk_reserved1) (void);
67 void (*_pk_reserved2) (void);
68 void (*_pk_reserved3) (void);
69 void (*_pk_reserved4) (void);
70 void (*_pk_reserved5) (void);
71 };
72
73 /**
74 * PkPackageSackSortType:
75 * @PK_PACKAGE_SACK_SORT_TYPE_NAME: Sort by name
76 * @PK_PACKAGE_SACK_SORT_TYPE_INFO: Sort by package info
77 * @PK_PACKAGE_SACK_SORT_TYPE_PACKAGE_ID: Sort by package ID
78 * @PK_PACKAGE_SACK_SORT_TYPE_SUMMARY: Sort by summary
79 * @PK_PACKAGE_SACK_SORT_TYPE_LAST:
80 *
81 * Type of sort to perform.
82 **/
83 typedef enum {
84 PK_PACKAGE_SACK_SORT_TYPE_NAME,
85 PK_PACKAGE_SACK_SORT_TYPE_INFO,
86 PK_PACKAGE_SACK_SORT_TYPE_PACKAGE_ID,
87 PK_PACKAGE_SACK_SORT_TYPE_SUMMARY,
88 PK_PACKAGE_SACK_SORT_TYPE_LAST
89 } PkPackageSackSortType;
90
91 GType pk_package_sack_get_type (void);
92 PkPackageSack *pk_package_sack_new (void);
93
94 /**
95 * PkPackageSackFilterFunc:
96 * @package: the package being considered
97 * @user_data: User data supplied when the callback was registered
98 *
99 * Function to filter packages in #PkPackageSack.
100 *
101 * Return value: %TRUE if @package should remain in the sack.
102 */
103 typedef gboolean (*PkPackageSackFilterFunc) (PkPackage *package,
104 gpointer user_data);
105
106 /* managing the array */
107 void pk_package_sack_clear (PkPackageSack *sack);
108 gchar **pk_package_sack_get_ids (PkPackageSack *sack);
109 guint pk_package_sack_get_size (PkPackageSack *sack);
110 GPtrArray *pk_package_sack_get_array (PkPackageSack *sack);
111 void pk_package_sack_sort (PkPackageSack *sack,
112 PkPackageSackSortType type);
113 gboolean pk_package_sack_add_package (PkPackageSack *sack,
114 PkPackage *package);
115 gboolean pk_package_sack_add_package_by_id (PkPackageSack *sack,
116 const gchar *package_id,
117 GError **error);
118 gboolean pk_package_sack_add_packages_from_file (PkPackageSack *sack,
119 GFile *file,
120 GError **error);
121 gboolean pk_package_sack_to_file (PkPackageSack *sack,
122 GFile *file,
123 GError **error);
124 gboolean pk_package_sack_remove_package (PkPackageSack *sack,
125 PkPackage *package);
126 gboolean pk_package_sack_remove_package_by_id (PkPackageSack *sack,
127 const gchar *package_id);
128 gboolean pk_package_sack_remove_by_filter (PkPackageSack *sack,
129 PkPackageSackFilterFunc filter_cb,
130 gpointer user_data);
131 PkPackage *pk_package_sack_find_by_id (PkPackageSack *sack,
132 const gchar *package_id);
133 PkPackage *pk_package_sack_find_by_id_name_arch (PkPackageSack *sack,
134 const gchar *package_id);
135 PkPackageSack *pk_package_sack_filter_by_info (PkPackageSack *sack,
136 PkInfoEnum info);
137 PkPackageSack *pk_package_sack_filter (PkPackageSack *sack,
138 PkPackageSackFilterFunc filter_cb,
139 gpointer user_data);
140 guint64 pk_package_sack_get_total_bytes (PkPackageSack *sack);
141
142 gboolean pk_package_sack_merge_generic_finish (PkPackageSack *sack,
143 GAsyncResult *res,
144 GError **error);
145
146 /* merging in data to the array using Resolve() */
147 void pk_package_sack_resolve_async (PkPackageSack *sack,
148 GCancellable *cancellable,
149 PkProgressCallback progress_callback,
150 gpointer progress_user_data,
151 GAsyncReadyCallback callback,
152 gpointer user_data);
153
154 /* merging in data to the array using Details() */
155 void pk_package_sack_get_details_async (PkPackageSack *sack,
156 GCancellable *cancellable,
157 PkProgressCallback progress_callback,
158 gpointer progress_user_data,
159 GAsyncReadyCallback callback,
160 gpointer user_data);
161
162 /* merging in data to the array using UpdateDetail() */
163 void pk_package_sack_get_update_detail_async (PkPackageSack *sack,
164 GCancellable *cancellable,
165 PkProgressCallback progress_callback,
166 gpointer progress_user_data,
167 GAsyncReadyCallback callback,
168 gpointer user_data);
169
170 G_END_DECLS
171
172 #endif /* __PK_PACKAGE_SACK_H */
173