mutt_logging.h File Reference

NeoMutt Logging. More...

#include <stdbool.h>
#include <stdint.h>
#include <time.h>
#include "mutt/lib.h"

Include dependency graph for mutt_logging.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	log_disp_curses (time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
	Display a log line in the message line - Implements log_dispatcher_t -. More...
void	mutt_log_prep (void)
	Prepare to log. More...
int	mutt_log_start (void)
	Enable file logging. More...
void	mutt_log_stop (void)
	Close the log file. More...
int	mutt_log_set_level (enum LogLevel level, bool verbose)
	Change the logging level. More...
int	mutt_log_set_file (const char *file, bool verbose)
	Change the logging file. More...
int	main_log_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t. More...
int	level_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "debug_level" config variable - Implements ConfigDef::validator() -. More...
void	mutt_clear_error (void)
	Clear the message line (bottom line of screen) More...

Detailed Description

NeoMutt Logging.

Authors

• Richard Russon

Copyright

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 http://www.gnu.org/licenses/.

Definition in file mutt_logging.h.

Function Documentation

mutt_log_prep()

void mutt_log_prep

(

void

)

Prepare to log.

Definition at line 211 of file mutt_logging.c.

{
  char ver[64];
  snprintf(ver, sizeof(ver), "-%s%s", PACKAGE_VERSION, GitVer);
  log_file_set_version(ver);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_start()

int mutt_log_start

(

void

)

Enable file logging.

Return values

0	Success, or already running
-1	Failed to start

This also handles file rotation.

Definition at line 284 of file mutt_logging.c.

{
  const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
  if (c_debug_level < 1)
    return 0;

  if (log_file_running())
    return 0;

  const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
  mutt_log_set_file(c_debug_file, false);

  /* This will trigger the file creation */
  if (log_file_set_level(c_debug_level, true) < 0)
    return -1;

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_stop()

void mutt_log_stop

(

void

)

Close the log file.

Definition at line 221 of file mutt_logging.c.

{
  log_file_close(false);
  FREE(&CurrentFile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_set_level()

int mutt_log_set_level	(	enum LogLevel	level,
		bool	verbose
	)

Change the logging level.

Parameters

level	Logging level
verbose	If true, then log the event

Return values

0	Success
-1	Error, level is out of range

Definition at line 262 of file mutt_logging.c.

{
  if (!CurrentFile)
  {
    const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
    mutt_log_set_file(c_debug_file, false);
  }

  if (log_file_set_level(level, verbose) != 0)
    return -1;

  cs_subset_str_native_set(NeoMutt->sub, "debug_level", level, NULL);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_set_file()

int mutt_log_set_file	(	const char *	file,
		bool	verbose
	)

Change the logging file.

Parameters

file	Name to use
verbose	If true, then log the event

Return values

0	Success, file opened
-1	Error, see errno

Close the old log, rotate the new logs and open the new log.

Definition at line 236 of file mutt_logging.c.

{
  const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
  if (!mutt_str_equal(CurrentFile, c_debug_file))
  {
    const char *name = rotate_logs(c_debug_file, NumOfLogs);
    if (!name)
      return -1;

    log_file_set_filename(name, false);
    FREE(&name);
    mutt_str_replace(&CurrentFile, c_debug_file);
  }

  cs_subset_str_string_set(NeoMutt->sub, "debug_file", file, NULL);

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

main_log_observer()

int main_log_observer

(

struct NotifyCallback *

nc

)

Notification that a Config Variable has changed - Implements observer_t.

Definition at line 321 of file mutt_logging.c.

{
  if ((nc->event_type != NT_CONFIG) || !nc->event_data)
    return -1;

  struct EventConfig *ev_c = nc->event_data;

  if (mutt_str_equal(ev_c->name, "debug_file"))
  {
    const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
    mutt_log_set_file(c_debug_file, true);
  }
  else if (mutt_str_equal(ev_c->name, "debug_level"))
  {
    const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
    mutt_log_set_level(c_debug_level, true);
  }
  else
  {
    return 0;
  }

  mutt_debug(LL_DEBUG5, "log done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_clear_error()

void mutt_clear_error

(

void

)

Clear the message line (bottom line of screen)

Definition at line 112 of file mutt_logging.c.

{
  /* Make sure the error message has had time to be read */
  if (OptMsgErr)
    error_pause();

  ErrorBufMessage = false;
  if (!OptNoCurses)
    msgwin_clear_text();
}

Here is the call graph for this function: