module.c File Reference

Definition of the Progress Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	progress_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	progress_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	progress_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	ProgressVars []
	Config definitions for the Progress Bar.
const struct Module	ModuleProgress
	Module for the Progress library.

Detailed Description

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

progress_init()

static bool progress_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 42 of file module.c.

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

progress_config_define_variables()

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

static

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

Definition at line 56 of file module.c.

{
  return cs_register_variables(cs, ProgressVars);
}

Here is the call graph for this function:

progress_cleanup()

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

static

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

Definition at line 64 of file module.c.

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

Here is the call graph for this function:

Variable Documentation

ProgressVars

struct ConfigDef ProgressVars[]

extern

Config definitions for the Progress Bar.

Definition at line 36 of file config.c.

                                  {
  // clang-format off
  { "net_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
    "(socket) Update the progress bar after this many KB sent/received (0 to disable)"
  },
  { "read_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
    "Update the progress bar after this many records read (0 to disable)"
  },
  { "time_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "Frequency of progress bar updates (milliseconds)"
  },
  { "write_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
    "Update the progress bar after this many records written (0 to disable)"
  },
  { NULL },
  // clang-format on
};

ModuleProgress

const struct Module ModuleProgress

Initial value:

= {
  MODULE_ID_PROGRESS,
  "progress",
  progress_init,
  NULL, 
  progress_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  progress_cleanup,
}

Module for the Progress library.

Definition at line 77 of file module.c.

                                     {
  MODULE_ID_PROGRESS,
  "progress",
  progress_init,
  NULL, // config_define_types
  progress_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  progress_cleanup,
};