modulemd/include/private/modulemd-profile-private.h - main - githubmirror/libmodulemd

modulemd/include/private/modulemd-profile-private.h
94 строки3 KB
Stephen Gallagher
Drop v1 code and refactor build system
17 июл 2019, 23:13
17 июл 2019, 23:131df0553
/*
 * 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-module-stream.h"
#include "modulemd-profile.h"

/**
 * SECTION: modulemd-profile-private
 * @title: Modulemd.Profile (Private)
 * @stability: Private
 * @short_description: #ModulemdProfile methods that should be used only
 * by internal consumers.
 */

/**
 * modulemd_profile_parse_yaml:
 * @parser: (inout): A libyaml parser object positioned at the beginning of a
 * Profile entry in the YAML document.
 * @name: (in): The name of this profile.
 * @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 that will return the reason for a parsing or
 * validation error.
 *
 * Returns: (transfer full): A newly-allocated #ModulemdProfile object
 * read from the YAML. NULL if a parse or validation error occurred and sets
 * @error appropriately.
 *
 * Since: 2.0
 */
ModulemdProfile *
modulemd_profile_parse_yaml (yaml_parser_t *parser,
                             const gchar *name,
                             gboolean strict,
                             GError **error);

/**
 * modulemd_profile_emit_yaml:
 * @self: This #ModulemdProfile object.
 * @emitter: (inout): A libyaml emitter object positioned where a Profile
 * belongs in the YAML document.
 * @error: (out): A #GError that will return the reason for an emission or
 * validation error.
 *
 * Returns: TRUE if the profile was emitted successfully. FALSE and sets
 * @error appropriately if the YAML could not be emitted.
 *
 * Since: 2.0
 */
gboolean
modulemd_profile_emit_yaml (ModulemdProfile *self,
                            yaml_emitter_t *emitter,
                            GError **error);

/**
 * modulemd_profile_equals_wrapper:
 * @a: A const void pointer.
 * @b: A const void pointer.
 *
 * Returns: TRUE, if both arguments are pointers to #ModulemdProfile objects
 * and all elements of both objects are equal. FALSE, otherwise.
 *
 * Since: 2.5
 */
gboolean
modulemd_profile_equals_wrapper (const void *a, const void *b);


/**
 * modulemd_profile_set_owner:
 * @self: This #ModulemdProfile object.
 * @owner: A #ModulemdModuleStream that will own this profile. Used to look up
 * translations internally.
 *
 * Since: 2.6
 */
void
modulemd_profile_set_owner (ModulemdProfile *self,
                            ModulemdModuleStream *owner);