/* SPDX-License-Identifier: MIT OR X11
 *
 * Copyright © 2024 Enrico Weigelt, metux IT consult <info@metux.net>
 */
#ifndef __XORG_OS_LOGGING_H
#define __XORG_OS_LOGGING_H

#include "include/os.h"

/**
 * @brief initialize logging and open log files
 *
 * Make backup of existing log file, create a new one and open it for logging.
 *
 * - May be called with NULL or "", if no logging is desired.
 *
 * - Must always be called, otherwise log messages will fill up the buffer and
 *   let it grow infinitely.
 *
 * - if "%s" is present in fname, it will be replaced with the display string or pid
 *
 * @param fname log file name template. if NULL, dont write any log.
 * @param backup name for the old logfile.
 * @return new log file name
 */
const char* LogInit(const char *fname, const char *backup);

/**
 * @brief rename the current log file according display name
 *
 * Renames the current log file with per display prefix (e.g. "Xorg.log.0")
 *
 */
void LogSetDisplay(void);

/**
 * @brief log exit code, then flush and close log file and write
 *
 * Logs the exit code (and success/error state), then flush and close log file.
 */
void LogClose(enum ExitCode error);

/* @brief parameters for LogSetParameter() */
typedef enum {
    XLOG_SYNC,            /* enable/disable fsync() after each log file write */
    XLOG_VERBOSITY,       /* set console log verbosity */
    XLOG_FILE_VERBOSITY,  /* set log file verbosity */
} LogParameter;

/**
 * @brief set log file paremeters
 *
 * Set various (int) logging parameters, eg. verbosity.
 * See XLOG_* defines
 *
 * @param ID of the parameter to set
 * @param value the new value
 * @result TRUE if successful
 */
int LogSetParameter(LogParameter param, int value);

#ifdef DEBUG
/**
 * @brief log debug messages (like errors) if symbol DEBUG is defined
 */
#define DebugF ErrorF
#else
#define DebugF(...)             /* */
#endif

#endif /* __XORG_OS_LOGGING_H */