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
|
/*
* This file is part of libmodulemd
* Copyright (C) 2018 Red Hat, Inc.
*
* Fedora-License-Identifier: MIT
* SPDX-2.0-License-Identifier: MIT
* SPDX-3.0-License-Identifier: MIT
*
* This program is free software.
* For more information on the license, see COPYING.
* For more information on free software, see <https://www.gnu.org/philosophy/free-sw.en.html>.
*/
#pragma once
#include "modulemd-module-index.h"
#include <glib-object.h>
#include <yaml.h>
G_BEGIN_DECLS
/**
* SECTION: modulemd-module-index-private
* @title: Modulemd.ModuleIndex (Private)
* @stability: Private
* @short_description: #ModulemdModuleIndex methods that should be used only
* by internal consumers.
*/
/**
* modulemd_module_index_update_from_file_ext:
* @self: This #ModulemdModuleIndex object.
* @yaml_file: (in): A YAML file containing the module metadata and other
* related information such as default streams.
* @strict: (in): Whether the parser should return failure if it encounters an
* unknown mapping key or if it should ignore it.
* @autogen_module_name: (in): Whether the parser should automatically generate
* a module name and stream name if they are not provided by the file being read
* in. This is intended mainly for applications interacting with modulemd docs
* that are build input.
* @failures: (out) (element-type ModulemdSubdocumentInfo) (transfer container):
* An array containing any subdocuments from the YAML file that failed to parse.
* See #ModulemdSubdocumentInfo for more details.
* @error: (out): A #GError containing additional information if this function
* fails in a way that prevents program continuation.
*
* Returns: TRUE if the update was successful. Returns FALSE and sets @failures
* appropriately if any of the YAML subdocuments were invalid or sets @error if
* there was a fatal parse error.
*
* Since: 2.9
*/
gboolean
modulemd_module_index_update_from_file_ext (ModulemdModuleIndex *self,
const gchar *yaml_file,
gboolean strict,
gboolean autogen_module_name,
GPtrArray **failures,
GError **error);
/**
* modulemd_module_index_update_from_parser:
* @self: (in): This #ModulemdModuleIndex object.
* @parser: (inout): An initialized YAML parser that has not yet processed any
* events.
* @strict: (in): Whether the parser should return failure if it encounters an
* unknown mapping key or if it should ignore it.
* @autogen_module_name: (in): When parsing a module stream that contains no
* module name or stream name, whether to autogenerate one or not. This option
* should be used only for validation tools such as modulemd-validator. Normal
* public routines should always set this to FALSE.
* @failures: (out) (element-type ModulemdSubdocumentInfo) (transfer container):
* An array containing any subdocuments from the YAML file that failed to parse.
* See #ModulemdSubdocumentInfo for more details. If the array is NULL, it will
* be allocated by this function. If it is non-NULL, this function will append
* to it.
* @error: (out): A #GError containing additional information if this function
* fails in a way that prevents program continuation.
*
* Returns: TRUE if the update was successful. Returns FALSE and sets failures
* appropriately if any of the YAML subdocuments were invalid or sets @error if
* there was a fatal parse error.
*
* Since: 2.0
*/
gboolean
modulemd_module_index_update_from_parser (ModulemdModuleIndex *self,
yaml_parser_t *parser,
gboolean strict,
gboolean autogen_module_name,
GPtrArray **failures,
GError **error);
/**
* modulemd_module_index_merge:
* @from: (in) (transfer none): The #ModulemdModuleIndex whose contents are
* being merged in.
* @into: (inout) (transfer none): The #ModulemdModuleIndex whose contents are
* being merged updated by those from @from.
* @override: (in): In the event that the contents cannot be merged, this
* argument specifies whether the contents of @from will supersede those from
* @into. For specifics of how this works, see the Description section for
* #ModulemdModuleIndexMerger.
* @strict_default_streams: (in): When merging #ModulemdDefaults, treat
* conflicting stream defaults as an error if this is True. Otherwise, on a
* conflict, the default stream will be unset.
* @error: (out): If the merge fails, this will return a #GError explaining the
* reason for it.
*
* Returns: TRUE if the two #ModulemdModuleIndex objects could be merged
* without conflicts. FALSE and sets @error appropriately if the merge fails.
*
* Since: 2.0
*/
gboolean
modulemd_module_index_merge (ModulemdModuleIndex *from,
ModulemdModuleIndex *into,
gboolean override,
gboolean strict_default_streams,
GError **error);
G_END_DECLS
|
