module.c File Reference

Definition of the Menu 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 "type.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	menu_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	menu_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	menu_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	menu_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()
static bool	menu_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	MenuVars []
	Config definitions for the Menu library.
const struct Module	ModuleMenu
	Module for the Menu library.

Detailed Description

Definition of the Menu 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

menu_init()

static bool menu_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 44 of file module.c.

{
  struct MenuModuleData *mod_data = MUTT_MEM_CALLOC(1, struct MenuModuleData);
  neomutt_set_module_data(n, MODULE_ID_MENU, 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:

menu_config_define_variables()

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

static

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

Definition at line 58 of file module.c.

{
  return cs_register_variables(cs, MenuVars);
}

Here is the call graph for this function:

menu_gui_init()

static bool menu_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 66 of file module.c.

{
  struct MenuModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_MENU);
  menu_init2(mod_data->search_buffers);
  return true;
}

Here is the call graph for this function:

menu_gui_cleanup()

static void menu_gui_cleanup ( struct NeoMutt * n )

static

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

Definition at line 76 of file module.c.

{
  struct MenuModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_MENU);
  ASSERT(mod_data);
 
  for (int i = 0; i < MENU_MAX; i++)
    FREE(&mod_data->search_buffers[i]);
}

Here is the call graph for this function:

menu_cleanup()

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

static

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

Definition at line 88 of file module.c.

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

Here is the call graph for this function:

Variable Documentation

MenuVars

struct ConfigDef MenuVars[]

extern

Config definitions for the Menu library.

Definition at line 37 of file config.c.

                              {
  // clang-format off
  { "arrow_cursor", DT_BOOL, false, 0, NULL,
    "Use an arrow '->' instead of highlighting in the index"
  },
  { "arrow_string", DT_STRING|D_NOT_EMPTY, IP "->", 0, NULL,
    "Use a custom string for arrow_cursor"
  },
  { "menu_context", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "Number of lines of overlap when changing pages in the index"
  },
  { "menu_move_off", DT_BOOL, true, 0, NULL,
    "Allow the last menu item to move off the bottom of the screen"
  },
  { "menu_scroll", DT_BOOL, false, 0, NULL,
    "Scroll the menu/index by one line, rather than a page"
  },
  { NULL },
  // clang-format on
};

ModuleMenu

const struct Module ModuleMenu

Initial value:

= {
  MODULE_ID_MENU,
  "menu",
  menu_init,
  NULL, 
  menu_config_define_variables,
  NULL, 
  menu_gui_init,
  menu_gui_cleanup,
  menu_cleanup,
}

Module for the Menu library.

Definition at line 101 of file module.c.

                                 {
  MODULE_ID_MENU,
  "menu",
  menu_init,
  NULL, // config_define_types
  menu_config_define_variables,
  NULL, // commands_register
  menu_gui_init,
  menu_gui_cleanup,
  menu_cleanup,
};