module.c File Reference

Definition of the Color Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	color_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	color_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	color_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	color_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	color_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()
static bool	color_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
const struct Command	ColorCommands []
	Colour Commands.
struct ConfigDef	ColorVars []
	Config definitions for the Color module.
const struct Module	ModuleColor
	Module for the Color library.

Detailed Description

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

color_init()

static bool color_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 44 of file module.c.

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

color_config_define_variables()

static bool color_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, ColorVars);
}

Here is the call graph for this function:

color_commands_register()

static bool color_commands_register ( struct NeoMutt * n, struct CommandArray * ca )

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 66 of file module.c.

{
  return commands_register(ca, ColorCommands);
}

Here is the call graph for this function:

color_gui_init()

static bool color_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 74 of file module.c.

{
  return true;
}

color_gui_cleanup()

static void color_gui_cleanup ( struct NeoMutt * n )

static

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

Definition at line 82 of file module.c.

{
  struct ColorModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_COLOR);
  colors_cleanup(mod_data);
}

Here is the call graph for this function:

color_cleanup()

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

static

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

Definition at line 91 of file module.c.

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

Here is the call graph for this function:

Variable Documentation

ColorCommands

const struct Command ColorCommands[]

extern

Colour Commands.

Definition at line 571 of file commands.c.

                                       {
  // clang-format off
  { "color", CMD_COLOR, parse_color,
        N_("Define colors for the user interface"),
        N_("color <object> [ <attribute> ... ] <fg> <bg> [ <regex> [ <num> ]]"),
        "configuration.html#color" },
  { "mono", CMD_MONO, parse_mono,
        N_("Deprecated: Use `color` instead"),
        N_("mono <object> <attribute> [ <pattern> | <regex> ]"),
        "configuration.html#color-mono" },
  { "uncolor", CMD_UNCOLOR, parse_uncolor,
        N_("Remove a `color` definition"),
        N_("uncolor <object> { * | <pattern> ... }"),
        "configuration.html#color" },
  { "unmono", CMD_UNMONO, parse_unmono,
        N_("Deprecated: Use `uncolor` instead"),
        N_("unmono <object> { * | <pattern> ... }"),
        "configuration.html#color-mono" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};

ColorVars

struct ConfigDef ColorVars[]

extern

Config definitions for the Color module.

Definition at line 37 of file config.c.

                               {
  // clang-format off
  { "color_directcolor", DT_BOOL|D_ON_STARTUP, false, 0, NULL,
    "Use 24bit colors (aka truecolor aka directcolor)"
  },
 
  { NULL },
  // clang-format on
};

ModuleColor

const struct Module ModuleColor

Initial value:

= {
  MODULE_ID_COLOR,
  "color",
  color_init,
  NULL, 
  color_config_define_variables,
  color_commands_register,
  color_gui_init,
  color_gui_cleanup,
  color_cleanup,
}

Module for the Color library.

Definition at line 104 of file module.c.

                                  {
  MODULE_ID_COLOR,
  "color",
  color_init,
  NULL, // config_define_types
  color_config_define_variables,
  color_commands_register,
  color_gui_init,
  color_gui_cleanup,
  color_cleanup,
};