mc/lib/logging.c
Andrew Borodin 7257f794d2 Update template for .c files.
Add section for forward declarations of local functions. This section is
located before file scope variables because functions can be used in
strucutres (see find.c for example):

/*** forward declarations (file scope functions) *************************************************/

/* button callbacks */
static int start_stop (WButton * button, int action);
static int find_do_view_file (WButton * button, int action);
static int find_do_edit_file (WButton * button, int action);

/*** file scope variables ************************************************************************/

static struct
{
    ...
    bcback_fn callback;
} fbuts[] =
{
    ...
    { B_STOP, NORMAL_BUTTON, N_("S&uspend"), 0, 0, NULL, start_stop },
    ...
    { B_VIEW, NORMAL_BUTTON, N_("&View - F3"), 0, 0, NULL, find_do_view_file },
    { B_VIEW, NORMAL_BUTTON, N_("&Edit - F4"), 0, 0, NULL, find_do_edit_file }
};

Signed-off-by: Andrew Borodin <aborodin@vmail.ru>
2023-03-19 20:34:24 +03:00

169 lines
4.8 KiB
C

/*
Provides a log file to ease tracing the program.
Copyright (C) 2006-2023
Free Software Foundation, Inc.
Written by:
Roland Illig <roland.illig@gmx.de>, 2006
Slava Zanko <slavazanko@gmail.com>, 2009, 2011
This file is part of the Midnight Commander.
The Midnight Commander 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.
The Midnight Commander 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 <http://www.gnu.org/licenses/>.
*/
/** \file logging.c
* \brief Source: provides a log file to ease tracing the program
*/
#include <config.h>
#include <stdarg.h>
#include <stdio.h>
#include "lib/global.h"
#include "lib/mcconfig.h"
#include "lib/fileloc.h"
#include "logging.h"
/*** global variables ****************************************************************************/
/*** file scope macro definitions ****************************************************************/
#define CONFIG_GROUP_NAME "Development"
#define CONFIG_KEY_NAME "logging"
#define CONFIG_KEY_NAME_FILE "logfile"
/*** file scope type declarations ****************************************************************/
/*** forward declarations (file scope functions) *************************************************/
/*** file scope variables ************************************************************************/
static gboolean logging_initialized = FALSE;
static gboolean logging_enabled = FALSE;
/* --------------------------------------------------------------------------------------------- */
/*** file scope functions ************************************************************************/
/* --------------------------------------------------------------------------------------------- */
static gboolean
is_logging_enabled_from_env (void)
{
const char *env_is_enabled;
env_is_enabled = g_getenv ("MC_LOG_ENABLE");
if (env_is_enabled == NULL)
return FALSE;
logging_enabled = (*env_is_enabled == '1' || g_ascii_strcasecmp (env_is_enabled, "true") == 0);
logging_initialized = TRUE;
return TRUE;
}
/* --------------------------------------------------------------------------------------------- */
static gboolean
is_logging_enabled (void)
{
if (logging_initialized)
return logging_enabled;
if (is_logging_enabled_from_env ())
return logging_enabled;
logging_enabled =
mc_config_get_bool (mc_global.main_config, CONFIG_GROUP_NAME, CONFIG_KEY_NAME, FALSE);
logging_initialized = TRUE;
return logging_enabled;
}
/* --------------------------------------------------------------------------------------------- */
static char *
get_log_filename (void)
{
const char *env_filename;
env_filename = g_getenv ("MC_LOG_FILE");
if (env_filename != NULL)
return g_strdup (env_filename);
if (mc_config_has_param (mc_global.main_config, CONFIG_GROUP_NAME, CONFIG_KEY_NAME_FILE))
return mc_config_get_string (mc_global.main_config, CONFIG_GROUP_NAME, CONFIG_KEY_NAME_FILE,
NULL);
return mc_config_get_full_path ("mc.log");
}
/* --------------------------------------------------------------------------------------------- */
static void
G_GNUC_PRINTF (1, 0)
mc_va_log (const char *fmt, va_list args)
{
char *logfilename;
logfilename = get_log_filename ();
if (logfilename != NULL)
{
FILE *f;
f = fopen (logfilename, "a");
if (f != NULL)
{
(void) vfprintf (f, fmt, args);
(void) fclose (f);
}
g_free (logfilename);
}
}
/* --------------------------------------------------------------------------------------------- */
/*** public functions ****************************************************************************/
/* --------------------------------------------------------------------------------------------- */
void
mc_log (const char *fmt, ...)
{
va_list args;
if (!is_logging_enabled ())
return;
va_start (args, fmt);
mc_va_log (fmt, args);
va_end (args);
}
/* --------------------------------------------------------------------------------------------- */
void
mc_always_log (const char *fmt, ...)
{
va_list args;
va_start (args, fmt);
mc_va_log (fmt, args);
va_end (args);
}
/* --------------------------------------------------------------------------------------------- */