/*
 * Copyright (C) 2023-2025 Birb Developers
 *
 * Birb is the legal property of its developers, whose names are too
 * numerous to list here. Please refer to the AUTHORS file distributed
 * with this source distribution
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses/>.
 */

#if !defined(BIRB_GLOBAL_HEADER_INSIDE) && !defined(BIRB_COMPILATION)
# error "only <birb.h> may be included directly"
#endif

#ifndef BIRB_STRING_OBJECT_H
#define BIRB_STRING_OBJECT_H

#include <glib.h>
#include <glib-object.h>

#include "birbversion.h"

G_BEGIN_DECLS

#define BIRB_TYPE_STRING_OBJECT (birb_string_object_get_type())

/**
 * BirbStringObject:
 *
 * A BirbStringObject is a simple [class@GObject.Object] that holds a string.
 *
 * It was created to hold strings in a [iface@Gio.ListModel].
 *
 * Since: 0.3
 */
BIRB_AVAILABLE_IN_0_3
G_DECLARE_FINAL_TYPE(BirbStringObject, birb_string_object, BIRB, STRING_OBJECT,
                     GObject)

/**
 * birb_string_object_equal:
 * @str1: (nullable): the first instance
 * @str2: (nullable): the second instance
 *
 * Checks if two string objects contain the same string.
 *
 * Returns: true if the strings are the same.
 *
 * Since: 0.4
 */
BIRB_AVAILABLE_IN_0_4
gboolean birb_string_object_equal(BirbStringObject *str1, BirbStringObject *str2);

/**
 * birb_string_object_get_string:
 *
 * Gets the string.
 *
 * Returns: The string.
 *
 * Since: 0.3
 */
BIRB_AVAILABLE_IN_0_3
const char *birb_string_object_get_string(BirbStringObject *obj);

/**
 * birb_string_object_new:
 * @str: (transfer none) (nullable): the string
 *
 * Creates a new string object.
 *
 * Returns: (transfer full): The new instance.
 *
 * Since: 0.3
 */
BIRB_AVAILABLE_IN_0_3
BirbStringObject *birb_string_object_new(const char *str);

/**
 * birb_string_object_set_string:
 * @str: (transfer none) (nullable): the new string
 *
 * Sets the string that the object contains.
 *
 * Since: 0.3
 */
BIRB_AVAILABLE_IN_0_3
void birb_string_object_set_string(BirbStringObject *obj, const char *str);

G_END_DECLS

#endif /* BIRB_STRING_OBJECT_H */
