module.c File Reference

Definition of the Gui 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/lib.h"
#include "curs_lib.h"
#include "module_data.h"
#include "mutt_curses.h"
#include "mutt_logging.h"
#include "mutt_window.h"
#include "rootwin.h"
#include "terminal.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static void	log_gui (void)
	Log info about the GUI.
static bool	gui_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	gui_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	gui_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	gui_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()
static bool	gui_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	GuiVars []
	Config definitions for the Gui library.
const struct Module	ModuleGui
	Module for the Gui library.

Detailed Description

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

log_gui()

static void log_gui ( void )

static

Log info about the GUI.

Definition at line 49 of file module.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
 
  const char *term = mutt_str_getenv("TERM");
  const char *color_term = mutt_str_getenv("COLORTERM");
  bool true_color = false;
#ifdef NEOMUTT_DIRECT_COLORS
  true_color = true;
#endif
 
  mutt_debug(LL_DEBUG1, "GUI:\n");
  mutt_debug(LL_DEBUG1, "    Curses: %s\n", curses_version());
  mutt_debug(LL_DEBUG1, "    COLORS=%d\n", COLORS);
  mutt_debug(LL_DEBUG1, "    COLOR_PAIRS=%d\n", COLOR_PAIRS);
  mutt_debug(LL_DEBUG1, "    TERM=%s\n", NONULL(term));
  mutt_debug(LL_DEBUG1, "    COLORTERM=%s\n", NONULL(color_term));
  mutt_debug(LL_DEBUG1, "    True color support: %s\n", true_color ? "YES" : "NO");
  if (mod_data->root_window)
  {
    mutt_debug(LL_DEBUG1, "    Screen: %dx%d\n", mod_data->root_window->state.cols,
               mod_data->root_window->state.rows);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

gui_init()

static bool gui_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 77 of file module.c.

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

gui_config_define_variables()

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

static

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

Definition at line 91 of file module.c.

{
  return cs_register_variables(cs, GuiVars);
}

Here is the call graph for this function:

gui_gui_init()

static bool gui_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 99 of file module.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_GUI);
 
  /* check whether terminal status is supported (must follow curses init) */
  mod_data->ts_supported = mutt_ts_capability();
  mutt_resize_screen();
  log_gui();
 
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  clear();
 
  MuttLogger = log_disp_curses;
  log_queue_flush(log_disp_curses);
  log_queue_set_max_size(5000);
 
  return true;
}

Here is the call graph for this function:

gui_gui_cleanup()

static void gui_gui_cleanup ( struct NeoMutt * n )

static

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

Definition at line 121 of file module.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_GUI);
  rootwin_cleanup(mod_data);
 
  mutt_endwin();
}

Here is the call graph for this function:

gui_cleanup()

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

static

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

Definition at line 132 of file module.c.

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

Here is the call graph for this function:

Variable Documentation

GuiVars

struct ConfigDef GuiVars[]

extern

Config definitions for the Gui library.

Definition at line 37 of file config.c.

                             {
  // clang-format off
  { "beep", DT_BOOL, true, 0, NULL,
    "Make a noise when an error occurs"
  },
  { "collapse_flagged", DT_BOOL, true, 0, NULL,
    "Prevent the collapse of threads with flagged emails"
  },
  { "collapse_unread", DT_BOOL, true, 0, NULL,
    "Prevent the collapse of threads with unread emails"
  },
  { "duplicate_threads", DT_BOOL, true, 0, NULL,
    "Highlight messages with duplicated message IDs"
  },
  { "hide_limited", DT_BOOL, false, 0, NULL,
    "Don't indicate hidden messages, in the thread tree"
  },
  { "hide_missing", DT_BOOL, true, 0, NULL,
    "Don't indicate missing messages, in the thread tree"
  },
  { "hide_thread_subject", DT_BOOL, true, 0, NULL,
    "Hide subjects that are similar to that of the parent message"
  },
  { "hide_top_limited", DT_BOOL, false, 0, NULL,
    "Don't indicate hidden top message, in the thread tree"
  },
  { "hide_top_missing", DT_BOOL, true, 0, NULL,
    "Don't indicate missing top message, in the thread tree"
  },
  { "narrow_tree", DT_BOOL, false, 0, NULL,
    "Draw a narrower thread tree in the index"
  },
  { "sort_re", DT_BOOL, true, 0, NULL,
    "Whether $reply_regex must be matched when not $strict_threads"
  },
  { "strict_threads", DT_BOOL, false, 0, NULL,
    "Thread messages using 'In-Reply-To' and 'References' headers"
  },
  { "thread_received", DT_BOOL, false, 0, NULL,
    "Sort threaded messages by their received date"
  },
 
  { NULL },
  // clang-format on
};

ModuleGui

const struct Module ModuleGui

Initial value:

= {
  MODULE_ID_GUI,
  "gui",
  gui_init,
  NULL, 
  gui_config_define_variables,
  NULL, 
  gui_gui_init,
  gui_gui_cleanup,
  gui_cleanup,
}

Module for the Gui library.

Definition at line 145 of file module.c.

                                {
  MODULE_ID_GUI,
  "gui",
  gui_init,
  NULL, // config_define_types
  gui_config_define_variables,
  NULL, // commands_register
  gui_gui_init,
  gui_gui_cleanup,
  gui_cleanup,
};