/*
 * SPDX-FileCopyrightText: 2003-2026 Sébastien Helleu <flashcode@flashtux.org>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of WeeChat, the extensible chat client.
 *
 * WeeChat 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 3 of the License, or
 * (at your option) any later version.
 *
 * WeeChat 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 WeeChat.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef WEECHAT_UPGRADE_FILE_H
#define WEECHAT_UPGRADE_FILE_H

#include <stdio.h>

#define UPGRADE_SIGNATURE "===== WeeChat Upgrade file v2.2 - binary, do not edit! ====="

/* stdio buffer size used for upgrade files (much bigger than the libc
 * default, since upgrade files are read/written as many small per-field
 * fread/fwrite calls) */
#define UPGRADE_FILE_BUFFER_SIZE (256 * 1024)

#define UPGRADE_ERROR(msg1, msg2)                                       \
    upgrade_file_error(upgrade_file, msg1, msg2, __FILE__, __LINE__)

struct t_infolist;

enum t_upgrade_type
{
    UPGRADE_TYPE_OBJECT_START = 0,
    UPGRADE_TYPE_OBJECT_END,
    UPGRADE_TYPE_OBJECT_VAR,
};

struct t_upgrade_file
{
    char *filename;                        /* filename with path            */
    FILE *file;                            /* file pointer                  */
    long read_offset;                      /* current read offset in file,  */
                                           /* tracked manually to avoid an  */
                                           /* ftell() call on every field   */
    long last_read_pos;                    /* last read position            */
    int last_read_length;                  /* last read length              */
    int (*callback_read)                   /* callback called when reading  */
    (const void *pointer,                  /* file                          */
     void *data,
     struct t_upgrade_file *upgrade_file,
     int object_id,
     struct t_infolist *infolist);
    const void *callback_read_pointer;     /* pointer sent to callback      */
    void *callback_read_data;              /* data sent to callback         */
    struct t_upgrade_file *prev_upgrade;   /* link to previous upgrade file */
    struct t_upgrade_file *next_upgrade;   /* link to next upgrade file     */
};

extern struct t_upgrade_file *upgrade_file_new (const char *filename,
                                                int (*callback_read)(const void *pointer,
                                                                     void *data,
                                                                     struct t_upgrade_file *upgrade_file,
                                                                     int object_id,
                                                                     struct t_infolist *infolist),
                                                const void *callback_read_pointer,
                                                void *callback_read_data);
extern int upgrade_file_write_object (struct t_upgrade_file *upgrade_file,
                                      int object_id,
                                      struct t_infolist *infolist);
extern int upgrade_file_read (struct t_upgrade_file *upgrade_file);
extern void upgrade_file_close (struct t_upgrade_file *upgrade_file);

#endif /* WEECHAT_UPGRADE_FILE_H */
