module.c File Reference

Definition of the Nntp 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	nntp_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	nntp_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	nntp_cleanup (struct NeoMutt *n)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	NntpVars []
	Config definitions for the NNTP library.
const struct Module	ModuleNntp
	Module for the Nntp library.

Detailed Description

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

nntp_init()

static bool nntp_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 42 of file module.c.

{
  // struct NntpModuleData *md = MUTT_MEM_CALLOC(1, struct NntpModuleData);
  // neomutt_set_module_data(n, MODULE_ID_NNTP, md);
 
  return true;
}

nntp_config_define_variables()

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

static

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

Definition at line 53 of file module.c.

{
  return cs_register_variables(cs, NntpVars);
}

Here is the call graph for this function:

nntp_cleanup()

static bool nntp_cleanup ( struct NeoMutt * n )

static

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

Definition at line 61 of file module.c.

{
  // struct NntpModuleData *md = neomutt_get_module_data(n, MODULE_ID_NNTP);
  // ASSERT(md);
 
  // FREE(&md);
  return true;
}

Variable Documentation

NntpVars

struct ConfigDef NntpVars[]

extern

Config definitions for the NNTP library.

Definition at line 59 of file config.c.

                              {
  // clang-format off
  { "catchup_newsgroup", DT_QUAD, MUTT_ASKYES, 0, NULL,
    "(nntp) Mark all articles as read when leaving a newsgroup"
  },
  { "followup_to_poster", DT_QUAD, MUTT_ASKYES, 0, NULL,
    "(nntp) Reply to the poster if 'poster' is in the 'Followup-To' header"
  },
  { "newsgroups_charset", DT_STRING, IP "utf-8", 0, charset_validator,
    "(nntp) Character set of newsgroups' descriptions"
  },
  { "newsrc", DT_EXPANDO|D_PATH_FILE, IP "~/.newsrc", IP &NntpFormatDef, NULL,
    "(nntp) File containing list of subscribed newsgroups"
  },
  { "news_cache_dir", DT_PATH|D_PATH_DIR, IP "~/.neomutt", 0, NULL,
    "(nntp) Directory for cached news articles"
  },
  { "news_server", DT_STRING, 0, 0, NULL,
    "(nntp) Url of the news server"
  },
  { "nntp_authenticators", DT_STRING, 0, 0, NULL,
    "(nntp) Allowed authentication methods"
  },
  { "nntp_context", DT_LONG|D_INTEGER_NOT_NEGATIVE, 1000, 0, NULL,
    "(nntp) Maximum number of articles to list (0 for all articles)"
  },
  { "nntp_listgroup", DT_BOOL, true, 0, NULL,
    "(nntp) Check all articles when opening a newsgroup"
  },
  { "nntp_load_description", DT_BOOL, true, 0, NULL,
    "(nntp) Load descriptions for newsgroups when adding to the list"
  },
  { "nntp_pass", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(nntp) Password for the news server"
  },
  { "nntp_poll", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 60, 0, NULL,
    "(nntp) Interval between checks for new posts"
  },
  { "nntp_user", DT_STRING|D_SENSITIVE, 0, 0, NULL,
    "(nntp) Username for the news server"
  },
  { "post_moderated", DT_QUAD, MUTT_ASKYES, 0, NULL,
    "(nntp) Allow posting to moderated newsgroups"
  },
  { "save_unsubscribed", DT_BOOL, false, 0, NULL,
    "(nntp) Save a list of unsubscribed newsgroups to the 'newsrc'"
  },
  { "show_new_news", DT_BOOL, true, 0, NULL,
    "(nntp) Check for new newsgroups when entering the browser"
  },
  { "x_comment_to", DT_BOOL, false, 0, NULL,
    "(nntp) Add 'X-Comment-To' header that contains article author"
  },
  { NULL },
  // clang-format on
};

ModuleNntp

const struct Module ModuleNntp

Initial value:

= {
  MODULE_ID_NNTP,
  "nntp",
  nntp_init,
  NULL, 
  nntp_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  nntp_cleanup,
}

Module for the Nntp library.

Definition at line 73 of file module.c.

                                 {
  MODULE_ID_NNTP,
  "nntp",
  nntp_init,
  NULL, // config_define_types
  nntp_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  nntp_cleanup,
};