module.c File Reference

Definition of the Sidebar Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/module_data.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	sidebar_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	sidebar_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	sidebar_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	sidebar_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()
static bool	sidebar_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	sidebar_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()

Variables
struct ConfigDef	SidebarVars []
	Config definitions for the sidebar.
const struct Command	SbCommands []
	Sidebar Commands.
const struct Module	ModuleSidebar
	Module for the Sidebar library.

Detailed Description

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

sidebar_init()

static bool sidebar_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 46 of file module.c.

{
  struct SidebarModuleData *mod_data = MUTT_MEM_CALLOC(1, struct SidebarModuleData);
  STAILQ_INIT(&mod_data->sidebar_pinned);
  neomutt_set_module_data(n, MODULE_ID_SIDEBAR, 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:

sidebar_config_define_variables()

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

static

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

Definition at line 61 of file module.c.

{
  return cs_register_variables(cs, SidebarVars);
}

Here is the call graph for this function:

sidebar_commands_register()

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

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 69 of file module.c.

{
  return commands_register(ca, SbCommands);
}

Here is the call graph for this function:

sidebar_cleanup()

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

static

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

Definition at line 77 of file module.c.

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

Here is the call graph for this function:

sidebar_gui_init()

static bool sidebar_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 91 of file module.c.

{
  struct GuiModuleData *gui_data = neomutt_get_module_data(n, MODULE_ID_GUI);
  sb_init(gui_data ? gui_data->all_dialogs_window : NULL);
  return true;
}

Here is the call graph for this function:

sidebar_gui_cleanup()

static void sidebar_gui_cleanup ( struct NeoMutt * n )

static

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

Definition at line 101 of file module.c.

{
  struct SidebarModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_SIDEBAR);
  struct GuiModuleData *gui_data = neomutt_get_module_data(n, MODULE_ID_GUI);
  sb_cleanup(&mod_data->sidebar_pinned, (gui_data ? gui_data->all_dialogs_window : NULL));
}

Here is the call graph for this function:

Variable Documentation

SidebarVars

struct ConfigDef SidebarVars[]

extern

Config definitions for the sidebar.

Definition at line 94 of file config.c.

                                 {
  // clang-format off
  { "sidebar_component_depth", DT_NUMBER, 0, 0, NULL,
    "(sidebar) Strip leading path components from sidebar folders"
  },
  { "sidebar_delim_chars", DT_STRING, IP "/.", 0, NULL,
    "(sidebar) Characters that separate nested folders"
  },
  { "sidebar_divider_char", DT_STRING, IP "\342\224\202", 0, NULL, // Box Drawings Light Vertical, U+2502
    "(sidebar) Character to draw between the sidebar and index"
  },
  { "sidebar_folder_indent", DT_BOOL, false, 0, NULL,
    "(sidebar) Indent nested folders"
  },
  { "sidebar_format", DT_EXPANDO|D_NOT_EMPTY, IP "%D%*  %n", IP &SidebarFormatDef, NULL,
    "(sidebar) printf-like format string for the sidebar panel"
  },
  { "sidebar_indent_string", DT_STRING, IP "  ", 0, NULL,
    "(sidebar) Indent nested folders using this string"
  },
  { "sidebar_new_mail_only", DT_BOOL, false, 0, NULL,
    "(sidebar) Only show folders with new/flagged mail"
  },
  { "sidebar_next_new_wrap", DT_BOOL, false, 0, NULL,
    "(sidebar) Wrap around when searching for the next mailbox with new mail"
  },
  { "sidebar_non_empty_mailbox_only", DT_BOOL, false, 0, NULL,
    "(sidebar) Only show folders with a non-zero number of mail"
  },
  { "sidebar_on_right", DT_BOOL, false, 0, NULL,
    "(sidebar) Display the sidebar on the right"
  },
  { "sidebar_short_path", DT_BOOL, false, 0, NULL,
    "(sidebar) Abbreviate the paths using the `$folder` variable"
  },
  { "sidebar_sort", DT_SORT, SB_SORT_UNSORTED, IP SidebarSortMethods, NULL,
    "(sidebar) Method to sort the sidebar"
  },
  { "sidebar_visible", DT_BOOL, false, 0, NULL,
    "(sidebar) Show the sidebar"
  },
  { "sidebar_width", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 30, 0, NULL,
    "(sidebar) Width of the sidebar"
  },
 
  { "sidebar_sort_method", DT_SYNONYM, IP "sidebar_sort", IP "2024-11-20" },
 
  { NULL },
  // clang-format on
};

SbCommands

const struct Command SbCommands[]

extern

Sidebar Commands.

Definition at line 48 of file sidebar.c.

                                    {
  // clang-format off
  { "sidebar-pin", CMD_SIDEBAR_PIN, parse_sidebar_pin,
        N_("Pin a mailbox in the sidebar (keep visible)"),
        N_("sidebar-pin <mailbox> [ <mailbox> ... ]"),
        "optionalfeatures.html#sidebar-pin" },
  { "sidebar-unpin", CMD_SIDEBAR_UNPIN, parse_sidebar_unpin,
        N_("Unpin a previously pinned mailbox in the sidebar"),
        N_("sidebar-unpin { * | <mailbox> ... }"),
        "optionalfeatures.html#sidebar-pin" },
 
  // Deprecated
  { "sidebar_pin",         CMD_NONE, NULL, "sidebar-pin",   NULL, NULL, CF_SYNONYM },
  { "sidebar_unpin",       CMD_NONE, NULL, "sidebar-unpin", NULL, NULL, CF_SYNONYM },
  { "sidebar_whitelist",   CMD_NONE, NULL, "sidebar-pin",   NULL, NULL, CF_SYNONYM },
  { "unsidebar_whitelist", CMD_NONE, NULL, "sidebar-unpin", NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};

ModuleSidebar

const struct Module ModuleSidebar

Initial value:

= {
  MODULE_ID_SIDEBAR,
  "sidebar",
  sidebar_init,
  NULL, 
  sidebar_config_define_variables,
  sidebar_commands_register,
  sidebar_gui_init,
  sidebar_gui_cleanup,
  sidebar_cleanup,
}

Module for the Sidebar library.

Definition at line 111 of file module.c.

                                    {
  MODULE_ID_SIDEBAR,
  "sidebar",
  sidebar_init,
  NULL, // config_define_types
  sidebar_config_define_variables,
  sidebar_commands_register,
  sidebar_gui_init,
  sidebar_gui_cleanup,
  sidebar_cleanup,
};