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

modulemd/include/private/modulemd-defaults-private.h

69 строк2 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) 2017-2018 Stephen Gallagher
 *
 * 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>

G_BEGIN_DECLS


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


#define DEFAULT_PLACEHOLDER "__DEFAULT_PLACEHOLDER__"


/**
 * modulemd_defaults_set_module_name:
 * @self: (in): This #ModulemdDefaults object.
 * @module_name: The module name this object represents.
 *
 * Since: 2.0
 */
void
modulemd_defaults_set_module_name (ModulemdDefaults *self,
                                   const gchar *module_name);

/**
 * modulemd_defaults_merge:
 * @from: (in): A #ModulemdDefaults object to merge from.
 * @into: (in): A #ModulemdDefaults object being merged into.
 * @strict_default_streams: (in): Whether a stream conflict should throw an
 * error or just unset the default stream.
 * @error: (out): A #GError containing the reason for an unresolvable merge
 * conflict.
 *
 * Performs a merge of two #ModulemdDefaults objects. See the documentation for
 * #ModulemdModuleIndexMerger for details on the merge algorithm used.
 *
 * Returns: (transfer full): A newly-allocated #ModulemdDefaults object
 * containing the merged values of @from and @into. If this function encounters
 * an unresolvable merge conflict, it will return NULL and set @error
 * appropriately.
 *
 * Since: 2.0
 */
ModulemdDefaults *
modulemd_defaults_merge (ModulemdDefaults *from,
                         ModulemdDefaults *into,
                         gboolean strict_default_streams,
                         GError **error);

G_END_DECLS