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
|
/*
* 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-dependencies.h"
/**
* SECTION: modulemd-dependencies-private
* @title: Modulemd.Dependencies (Private)
* @stability: Private
* @short_description: #ModulemdDependencies methods that should be used only
* by internal consumers.
*/
/**
* modulemd_dependencies_parse_yaml:
* @parser: (inout): A libyaml parser object positioned at a sequence entry for
* a Dependencies object.
* @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 #ModulemdDependencies object
* read from the YAML. NULL if a parse or validation error occurred and sets
* @error appropriately.
*
* Since: 2.0
*/
ModulemdDependencies *
modulemd_dependencies_parse_yaml (yaml_parser_t *parser,
gboolean strict,
GError **error);
/**
* modulemd_dependencies_emit_yaml:
* @self: This #ModulemdDependencies object.
* @emitter: (inout): A libyaml emitter object positioned where a dependencies instance
* belongs in the YAML document.
* @error: (out): A #GError that will return the reason for an emission or
* validation error.
*
* Returns: TRUE if the dependencies object was emitted successfully. FALSE and sets
* @error appropriately if the YAML could not be emitted.
*
* Since: 2.0
*/
gboolean
modulemd_dependencies_emit_yaml (ModulemdDependencies *self,
yaml_emitter_t *emitter,
GError **error);
/**
* modulemd_dependencies_validate:
* @self: This #ModulemdDependencies object.
* @error: (out): A #GError containing the reason the object failed validation.
* NULL if the validation passed.
*
* Returns: TRUE if validation passed. FALSE and sets @error if failed.
*
* This method runs a sanity check that the runtime (requires) and buildtime
* (buildrequires) dependencies are internally consistent.
*
* Since: 2.0
*/
gboolean
modulemd_dependencies_validate (ModulemdDependencies *self, GError **error);
/**
* modulemd_dependencies_requires_module_and_stream:
* @self: This #ModulemdDependencies object.
* @module_name: (in): The name of the module to be checked.
* @stream_name: (in): The name of the stream to be checked.
*
* Returns: TRUE if the specified runtime dependency is present. FALSE if not.
*
* This method checks if the runtime dependencies for this object include the
* specified module stream.
*
* Since: 2.2
*/
gboolean
modulemd_dependencies_requires_module_and_stream (ModulemdDependencies *self,
const gchar *module_name,
const gchar *stream_name);
/**
* modulemd_dependencies_buildrequires_module_and_stream:
* @self: This #ModulemdDependencies object.
* @module_name: (in): The name of the module to be checked.
* @stream_name: (in): The name of the stream to be checked.
*
* Returns: TRUE if the specified buildtime dependency is present. FALSE if not.
*
* This method checks if the buildtime dependencies for this object include the
* specified module stream.
*
* Since: 2.2
*/
gboolean
modulemd_dependencies_buildrequires_module_and_stream (
ModulemdDependencies *self,
const gchar *module_name,
const gchar *stream_name);
|