summaryrefslogtreecommitdiff
path: root/common/flatpak-ref-utils-private.h
blob: a62d7b9ae5557387a55fc97ff75850fb1efe1ac0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*
 * Copyright © 2020 Red Hat, Inc
 *
 * This program 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, see <http://www.gnu.org/licenses/>.
 *
 * Authors:
 *       Alexander Larsson <alexl@redhat.com>
 */

#include <flatpak-common-types-private.h>
#include <flatpak-ref.h>

#ifndef __FLATPAK_REF_UTILS_H__
#define __FLATPAK_REF_UTILS_H__

gboolean flatpak_is_valid_name (const char *string,
                                gssize      len,
                                GError    **error);
gboolean flatpak_is_valid_branch (const char *string,
                                  gssize      len,
                                  GError    **error);
gboolean flatpak_is_valid_arch (const char *string,
                                gssize      len,
                                GError    **error);
gboolean flatpak_has_name_prefix (const char *string,
                                  const char *name);
gboolean flatpak_name_matches_one_wildcard_prefix (const char         *string,
                                                   const char * const *maybe_wildcard_prefixes,
                                                   gboolean            require_exact_match);

char * flatpak_make_valid_id_prefix (const char *orig_id);
gboolean flatpak_id_has_subref_suffix (const char *id,
                                       gssize      id_len);

gboolean flatpak_is_app_runtime_or_appstream_ref (const char *ref);
char * flatpak_get_arch_for_ref (const char *ref);
const char *flatpak_get_compat_arch_reverse (const char *compat_arch);

FlatpakKinds flatpak_kinds_from_kind (FlatpakRefKind kind);

typedef struct _FlatpakDecomposed FlatpakDecomposed;
FlatpakDecomposed *flatpak_decomposed_new_from_ref          (const char         *ref,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_col_ref      (const char         *ref,
                                                             const char         *collection_id,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_refspec      (const char         *refspec,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_ref_take     (char               *ref,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_refspec_take (char               *refspec,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_parts        (FlatpakKinds        kind,
                                                             const char         *id,
                                                             const char         *arch,
                                                             const char         *branch,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_decomposed   (FlatpakDecomposed  *ref,
                                                             FlatpakKinds        opt_kind,
                                                             const char         *opt_id,
                                                             const char         *opt_arch,
                                                             const char         *opt_branch,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_new_from_pref         (FlatpakKinds        kind,
                                                             const char         *pref,
                                                             GError            **error);
FlatpakDecomposed *flatpak_decomposed_ref                   (FlatpakDecomposed  *ref);
void               flatpak_decomposed_unref                 (FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_get_ref               (FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_get_refspec           (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_ref               (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_refspec           (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_remote            (FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_get_collection_id     (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_collection_id     (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_equal                 (FlatpakDecomposed  *ref_a,
                                                             FlatpakDecomposed  *ref_b);
gboolean           flatpak_decomposed_equal_except_branch   (FlatpakDecomposed  *ref_a,
                                                             FlatpakDecomposed  *ref_b);
gboolean           flatpak_decomposed_equal_except_arch     (FlatpakDecomposed  *ref_a,
                                                             FlatpakDecomposed  *ref_b);
gint               flatpak_decomposed_strcmp                (FlatpakDecomposed  *ref_a,
                                                             FlatpakDecomposed  *ref_b);
gint               flatpak_decomposed_strcmp_p              (FlatpakDecomposed **ref_a,
                                                             FlatpakDecomposed **ref_b);
guint              flatpak_decomposed_hash                  (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_is_app                (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_is_runtime            (FlatpakDecomposed  *ref);
FlatpakKinds       flatpak_decomposed_get_kinds             (FlatpakDecomposed  *ref);
FlatpakRefKind     flatpak_decomposed_get_kind              (FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_get_kind_str          (FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_get_kind_metadata_group(FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_get_pref              (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_pref              (FlatpakDecomposed  *ref);
const char *       flatpak_decomposed_peek_id               (FlatpakDecomposed  *ref,
                                                             gsize              *out_len);
char *             flatpak_decomposed_dup_id                (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_readable_id       (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_is_id                 (FlatpakDecomposed  *ref,
                                                             const char         *id);
gboolean           flatpak_decomposed_id_has_suffix         (FlatpakDecomposed  *ref,
                                                             const char         *suffix);
gboolean           flatpak_decomposed_id_has_prefix         (FlatpakDecomposed  *ref,
                                                             const char         *prefix);
gboolean           flatpak_decomposed_is_id_fuzzy           (FlatpakDecomposed  *ref,
                                                             const char         *id);
gboolean           flatpak_decomposed_id_is_subref          (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_id_is_subref_of       (FlatpakDecomposed  *ref,
                                                             FlatpakDecomposed  *parent_ref);
const char *       flatpak_decomposed_peek_arch             (FlatpakDecomposed  *ref,
                                                             gsize              *out_len);
char *             flatpak_decomposed_dup_arch              (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_is_arch               (FlatpakDecomposed  *ref,
                                                             const char         *arch);
gboolean           flatpak_decomposed_is_arches             (FlatpakDecomposed  *ref,
                                                             gssize              len,
                                                             const char        **arches);
const char *       flatpak_decomposed_peek_branch           (FlatpakDecomposed  *ref,
                                                             gsize              *out_len);
const char *       flatpak_decomposed_get_branch            (FlatpakDecomposed  *ref);
char *             flatpak_decomposed_dup_branch            (FlatpakDecomposed  *ref);
gboolean           flatpak_decomposed_is_branch             (FlatpakDecomposed  *ref,
                                                             const char         *branch);

G_DEFINE_AUTOPTR_CLEANUP_FUNC (FlatpakDecomposed, flatpak_decomposed_unref)

FlatpakKinds flatpak_kinds_from_bools (gboolean app,
                                       gboolean runtime);

gboolean flatpak_split_partial_ref_arg (const char   *partial_ref,
                                        FlatpakKinds  default_kinds,
                                        const char   *default_arch,
                                        const char   *default_branch,
                                        FlatpakKinds *out_kinds,
                                        char        **out_id,
                                        char        **out_arch,
                                        char        **out_branch,
                                        GError      **error);
gboolean flatpak_split_partial_ref_arg_novalidate (const char   *partial_ref,
                                                   FlatpakKinds  default_kinds,
                                                   const char   *default_arch,
                                                   const char   *default_branch,
                                                   FlatpakKinds *out_kinds,
                                                   char        **out_id,
                                                   char        **out_arch,
                                                   char        **out_branch);

int flatpak_compare_ref (const char *ref1,
                         const char *ref2);

char * flatpak_build_untyped_ref (const char *runtime,
                                  const char *branch,
                                  const char *arch);
char * flatpak_build_runtime_ref (const char *runtime,
                                  const char *branch,
                                  const char *arch);
char * flatpak_build_app_ref (const char *app,
                              const char *branch,
                              const char *arch);


#endif /* __FLATPAK_REF_UTILS_H__ */