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
|
/*
* 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 <glib-object.h>
#include <yaml.h>
#include "modulemd-subdocument-info.h"
#include "private/modulemd-yaml.h"
/**
* SECTION: modulemd-subdocument-info-private
* @title: Modulemd.SubdocumentInfo (Private)
* @stability: Private
* @short_description: #ModulemdSubdocumentInfo methods that should be used only
* by internal consumers.
*/
/**
* modulemd_subdocument_info_new:
*
* Returns: (transfer full): A newly-allocated #ModulemdSubdocumentInfo object.
*
* Since: 2.0
*/
ModulemdSubdocumentInfo *
modulemd_subdocument_info_new (void);
/**
* modulemd_subdocument_info_copy:
* @self: This #ModulemdSubdocumentInfo object.
*
* Returns: (transfer full): A deep copy of @self.
*
* Since: 2.0
*/
ModulemdSubdocumentInfo *
modulemd_subdocument_info_copy (ModulemdSubdocumentInfo *self);
/**
* modulemd_subdocument_info_set_doctype:
* @self: This #ModulemdSubdocumentInfo object.
* @doctype: The #ModulemdYamlDocumentTypeEnum represented by this subdocument
* object.
*
* Since: 2.0
*/
void
modulemd_subdocument_info_set_doctype (ModulemdSubdocumentInfo *self,
ModulemdYamlDocumentTypeEnum doctype);
/**
* modulemd_subdocument_info_get_doctype:
* @self: This #ModulemdSubdocumentInfo object.
*
* Returns: The type of subdocument represented by this #ModulemdSubdocumentInfo object.
*
* Since: 2.0
*/
ModulemdYamlDocumentTypeEnum
modulemd_subdocument_info_get_doctype (ModulemdSubdocumentInfo *self);
/**
* modulemd_subdocument_info_set_mdversion:
* @self: This #ModulemdSubdocumentInfo object.
* @mdversion: The metadata version of this #ModulemdSubdocumentInfo object.
*
* Since: 2.0
*/
void
modulemd_subdocument_info_set_mdversion (ModulemdSubdocumentInfo *self,
guint64 mdversion);
/**
* modulemd_subdocument_info_get_mdversion:
* @self: This #ModulemdSubdocumentInfo object.
*
* Returns: The metadata version of this #ModulemdSubdocumentInfo object.
*
* Since: 2.0
*/
guint64
modulemd_subdocument_info_get_mdversion (ModulemdSubdocumentInfo *self);
/**
* modulemd_subdocument_info_set_yaml:
* @self: This #ModulemdSubdocumentInfo object.
* @contents: The contents of the document.
*
* Since: 2.0
*/
void
modulemd_subdocument_info_set_yaml (ModulemdSubdocumentInfo *self,
const gchar *contents);
/**
* modulemd_subdocument_info_set_gerror:
* @self: This #ModulemdSubdocumentInfo object.
* @error: The error.
*
* Since: 2.0
*/
void
modulemd_subdocument_info_set_gerror (ModulemdSubdocumentInfo *self,
const GError *error);
/**
* modulemd_subdocument_info_get_data_parser:
* @self: This #ModulemdSubdocumentInfo object.
* @parser: (inout): An unconfigured libyaml parser.
* @strict: (in): Whether the parser should return failure if it encounters an
* unknown mapping key or if it should ignore it.
* @error: (out): A #GError containing the parser error if this function fails.
*
* Since: 2.0
*/
gboolean
modulemd_subdocument_info_get_data_parser (ModulemdSubdocumentInfo *self,
yaml_parser_t *parser,
gboolean strict,
GError **error);
/**
* modulemd_subdocument_info_debug_dump_failures:
* @failures: (in) (element-type ModulemdSubdocumentInfo): An array containing
* any subdocuments from the YAML file that failed to parse.
*
* Dumps human readable information about @failures to the debug log.
*
* Since: 2.10
*/
void
modulemd_subdocument_info_debug_dump_failures (GPtrArray *failures);
|
