module.c File Reference

Definition of the History Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	history_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	history_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	history_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()
static bool	history_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	history_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()

Variables
struct ConfigDef	HistoryVars []
	Config definitions for the command history.
const struct Module	ModuleHistory
	Module for the History library.

Detailed Description

Definition of the History Module.

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 module.c.

Function Documentation

history_init()

static bool history_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 43 of file module.c.

{
  struct HistoryModuleData *mod_data = MUTT_MEM_CALLOC(1, struct HistoryModuleData);
  neomutt_set_module_data(n, MODULE_ID_HISTORY, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

history_config_define_variables()

static bool history_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 57 of file module.c.

{
  return cs_register_variables(cs, HistoryVars);
}

Here is the call graph for this function:

history_cleanup()

static bool history_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 65 of file module.c.

{
  struct HistoryModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

history_gui_init()

static bool history_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 78 of file module.c.

{
  struct HistoryModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_HISTORY);
  mutt_hist_init(mod_data);
  mutt_hist_read_file();
  return true;
}

Here is the call graph for this function:

history_gui_cleanup()

static void history_gui_cleanup ( struct NeoMutt * n )

static

Clean up the GUI - Implements Module::gui_cleanup()

Definition at line 89 of file module.c.

{
  struct HistoryModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_HISTORY);
  mutt_hist_cleanup(mod_data);
}

Here is the call graph for this function:

Variable Documentation

HistoryVars

struct ConfigDef HistoryVars[]

extern

Config definitions for the command history.

Definition at line 56 of file config.c.

                                 {
  // clang-format off
  { "history", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
    "Number of history entries to keep in memory per category"
  },
  { "history_file", DT_PATH|D_PATH_FILE, IP "~/.mutthistory", 0, NULL,
    "File to save history in"
  },
  { "history_format", DT_EXPANDO, IP "%s", IP &HistoryFormatDef, NULL,
    "printf-like format string for the history menu"
  },
  { "history_remove_dups", DT_BOOL, false, 0, NULL,
    "Remove duplicate entries from the history"
  },
  { "save_history", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "Number of history entries to save per category"
  },
  { NULL },
  // clang-format on
};

ModuleHistory

const struct Module ModuleHistory

Initial value:

= {
  MODULE_ID_HISTORY,
  "history",
  history_init,
  NULL, 
  history_config_define_variables,
  NULL, 
  history_gui_init,
  history_gui_cleanup,
  history_cleanup,
}

Module for the History library.

Definition at line 98 of file module.c.

                                    {
  MODULE_ID_HISTORY,
  "history",
  history_init,
  NULL, // config_define_types
  history_config_define_variables,
  NULL, // commands_register
  history_gui_init,
  history_gui_cleanup,
  history_cleanup,
};