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
|
/*
* 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-translation-entry.h"
#include <glib-object.h>
G_BEGIN_DECLS
/**
* SECTION: modulemd-translation
* @title: Modulemd.Translation
* @stability: stable
* @short_description: Translation information for a module stream.
*/
#define MODULEMD_TYPE_TRANSLATION (modulemd_translation_get_type ())
G_DECLARE_FINAL_TYPE (
ModulemdTranslation, modulemd_translation, MODULEMD, TRANSLATION, GObject)
/**
* modulemd_translation_new:
* @version: The metadata version of this #ModulemdTranslation.
* @module_name: The name of the module to which these translations apply.
* @module_stream: The name of the module stream to which these translations apply.
* @modified: The last modified time represented as a 64-bit integer (such as
* 201807011200).
*
* Returns: (transfer full): A newly-allocated #ModulemdTranslation object.
* This object must be freed with g_object_unref().
*
* Since: 2.0
*/
ModulemdTranslation *
modulemd_translation_new (guint64 version,
const gchar *module_name,
const gchar *module_stream,
guint64 modified);
/**
* modulemd_translation_copy:
* @self: This #ModulemdTranslation object.
*
* Create a copy of this #ModulemdTranslation object.
*
* Returns: (transfer full): The copied #ModulemdTranslation object.
*
* Since: 2.0
*/
ModulemdTranslation *
modulemd_translation_copy (ModulemdTranslation *self);
/**
* modulemd_translation_validate:
* @self: This #ModulemdTranslation object.
* @error: (out): If the object is not valid, it will return the reason.
*
* This method ensures that the translation is internally consistent for usage
* or dumping to YAML. It will be run implicitly prior to emitting YAML. This
* is not a complete linter, merely a sanity check that the values are not
* impossible.
*
* Since: 2.0
*/
gboolean
modulemd_translation_validate (ModulemdTranslation *self, GError **error);
/**
* modulemd_translation_set_modified:
* @self: This #ModulemdTranslation object.
* @modified: The last modified time represented as a 64-bit integer (such as
* 201807011200).
*
* Since: 2.0
*/
void
modulemd_translation_set_modified (ModulemdTranslation *self,
guint64 modified);
/**
* modulemd_translation_get_locales_as_strv: (rename-to modulemd_translation_get_locales)
* @self: This #ModulemdTranslation object.
*
* Returns: (transfer full): An ordered #GStrv list of locales known to this
* #ModulemdTranslation.
*
* Since: 2.0
*/
GStrv
modulemd_translation_get_locales_as_strv (ModulemdTranslation *self);
/**
* modulemd_translation_set_translation_entry:
* @self: This #ModulemdTranslation object.
* @translation_entry: A set of translations of this module stream for a particular locale.
*
* Since: 2.0
*/
void
modulemd_translation_set_translation_entry (
ModulemdTranslation *self, ModulemdTranslationEntry *translation_entry);
/**
* modulemd_translation_get_translation_entry:
* @self: This #ModulemdTranslation object.
* @locale: The locale of the translation to retrieve.
*
* Returns: (transfer none): The translation entry for the requested locale, or NULL if the locale was unknown.
*
* Since: 2.0
*/
ModulemdTranslationEntry *
modulemd_translation_get_translation_entry (ModulemdTranslation *self,
const gchar *locale);
G_END_DECLS
|
