/* ui.h -- User Interface

   This file is part of the UPX executable compressor.

   Copyright (C) 1996-2025 Markus Franz Xaver Johannes Oberhumer
   Copyright (C) 1996-2025 Laszlo Molnar
   All Rights Reserved.

   UPX and the UCL library are free software; you can redistribute them
   and/or modify them 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; see the file COPYING.
   If not, write to the Free Software Foundation, Inc.,
   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

   Markus F.X.J. Oberhumer              Laszlo Molnar
   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
 */

#pragma once

class OutputFile;
class PackerBase;

/*************************************************************************
//
**************************************************************************/

class UiPacker final {
public:
    explicit UiPacker(const PackerBase *);

public:
    virtual ~UiPacker() noexcept;

    static void uiConfirmUpdate();
    static void uiPackTotal();
    static void uiUnpackTotal();
    static void uiListTotal(bool uncompress = false);
    static void uiTestTotal();
    static void uiFileInfoTotal();

    virtual void uiPackStart(const OutputFile *fo);
    virtual void uiPackEnd(const OutputFile *fo);
    virtual void uiUnpackStart(const OutputFile *fo);
    virtual void uiUnpackEnd(const OutputFile *fo);
    virtual void uiListStart();
    virtual void uiList();
    virtual void uiListEnd();
    virtual void uiTestStart();
    virtual void uiTestEnd();
    virtual bool uiFileInfoStart();
    virtual void uiFileInfoEnd();

    // callback
    virtual void startCallback(unsigned u_len, unsigned step, int pass, int total_passes);
    virtual void firstCallback();
    virtual void finalCallback(unsigned u_len, unsigned c_len);
    virtual void endCallback();
    virtual void endCallback(bool done);
    virtual upx_callback_t *getCallback() { return &cb; }

protected:
    static void __acc_cdecl progress_callback(upx_callback_t *, unsigned, unsigned);
    virtual void doCallback(unsigned isize, unsigned osize);

protected:
    virtual void uiUpdate(upx_off_t fc_len = -1, upx_off_t fu_len = -1);

public:
    static void uiHeader();
    static void uiFooter(const char *n);

    int ui_pass = 0;
    int ui_total_passes = 0;

protected:
    virtual void printInfo(int nl = 0);
    const PackerBase *const pb; // reference, required

    // callback
    upx_callback_t cb = {};

    // internal state
    struct State;
    OwningPointer(State) s = nullptr; // owner

    // static totals
    static unsigned total_files;
    static unsigned total_files_done;
    static upx_uint64_t total_c_len;
    static upx_uint64_t total_u_len;
    static upx_uint64_t total_fc_len;
    static upx_uint64_t total_fu_len;
    static unsigned update_c_len;
    static unsigned update_u_len;
    static unsigned update_fc_len;
    static unsigned update_fu_len;

private: // UPX conventions
    UPX_CXX_DISABLE_ADDRESS(UiPacker)
    UPX_CXX_DISABLE_COPY_MOVE(UiPacker)
};

/* vim:set ts=4 sw=4 et: */
