version.c File Reference

Display version and copyright about NeoMutt. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <sys/utsname.h>
#include <unistd.h>
#include "mutt/mutt.h"
#include "email/lib.h"
#include "mutt_curses.h"
#include "ncrypt/crypt_gpgme.h"

Include dependency graph for version.c:

Go to the source code of this file.

Data Structures
struct	CompileOptions
	List of built-in capabilities. More...

Functions
const char *	mutt_make_version (void)
	Generate the NeoMutt version string. More...
const char *	mutt_hcache_backend_list (void)
	Get a list of backend names. More...
static void	print_compile_options (struct CompileOptions *co)
	Print a list of enabled/disabled features. More...
static char *	rstrip_in_place (char *s)
	Strip a trailing carriage return. More...
void	print_version (void)
	Print system and compile info. More...
void	print_copyright (void)
	Print copyright message. More...
bool	feature_enabled (const char *name)
	Test if a compile-time feature is enabled. More...

Variables
const int	SCREEN_WIDTH = 80
unsigned char	cc_version []
unsigned char	cc_cflags []
unsigned char	configure_options []
static const char *	Copyright
static const char *	Thanks
static const char *	License
static const char *	ReachingUs
static const char *	Notice
static struct CompileOptions	comp_opts_default []
static struct CompileOptions	comp_opts []

Detailed Description

Display version and copyright about NeoMutt.

Authors

• Michael R. Elkins
• Thomas Roessler
• 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 version.c.

Function Documentation

const char* mutt_make_version

(

void

)

Generate the NeoMutt version string.

Return values

ptr	Version string

Note

This returns a pointer to a static buffer

Definition at line 1492 of file muttlib.c.

{
  static char vstring[STRING];
  snprintf(vstring, sizeof(vstring), "NeoMutt %s%s", PACKAGE_VERSION, GitVer);
  return vstring;
}

Here is the caller graph for this function:

const char* mutt_hcache_backend_list

(

void

)

Get a list of backend names.

get a list of backend identification strings

Return values

ptr	Comma-space-separated list of names

The caller should free the string.

Definition at line 463 of file hcache.c.

{
  char tmp[STRING] = { 0 };
  const struct HcacheOps **ops = hcache_ops;
  size_t len = 0;

  for (; *ops; ++ops)
  {
    if (len != 0)
    {
      len += snprintf(tmp + len, STRING - len, ", ");
    }
    len += snprintf(tmp + len, STRING - len, "%s", (*ops)->name);
  }

  return mutt_str_strdup(tmp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void print_compile_options ( struct CompileOptions *  co )

static

Print a list of enabled/disabled features.

Parameters

co	Array of compile options

Two lists are generated and passed to this function:

One list which just uses the configure state of each feature. One list which just uses feature which are set to on directly in NeoMutt.

The output is of the form: "+enabled_feature -disabled_feature" and is wrapped to SCREEN_WIDTH characters.

Definition at line 303 of file version.c.

{
  size_t used = 2;
  bool tty = stdout ? isatty(fileno(stdout)) : false;

  printf("  ");
  for (int i = 0; co[i].name; i++)
  {
    const size_t len = strlen(co[i].name) + 2; /* +/- and a space */
    if ((used + len) > SCREEN_WIDTH)
    {
      used = 2;
      printf("\n  ");
    }
    used += len;
    if (co[i].enabled)
    {
      if (tty)
        printf("\033[1;32m+%s\033[0m ", co[i].name);
      else
        printf("+%s ", co[i].name);
    }
    else
    {
      if (tty)
        printf("\033[1;31m-%s\033[0m ", co[i].name);
      else
        printf("-%s ", co[i].name);
    }
  }
  puts("");
}

Here is the caller graph for this function:

static char* rstrip_in_place ( char *  s )

static

Strip a trailing carriage return.

Parameters

s	String to be modified

Return values

ptr	The modified string

The string has its last carriage return set to NUL.

Definition at line 343 of file version.c.

{
  if (!s)
    return NULL;

  char *p = &s[strlen(s)];
  if (p == s)
    return s;
  p--;
  while ((p >= s) && ((*p == '\n') || (*p == '\r')))
    *p-- = '\0';
  return s;
}

Here is the caller graph for this function:

void print_version

(

void

)

Print system and compile info.

Print information about the current system NeoMutt is running on. Also print a list of all the compile-time information.

Definition at line 363 of file version.c.

{
  struct utsname uts;

  puts(mutt_make_version());
  puts(_(Notice));

  uname(&uts);

#ifdef SCO
  printf("System: SCO %s", uts.release);
#else
  printf("System: %s %s", uts.sysname, uts.release);
#endif

  printf(" (%s)", uts.machine);

#ifdef NCURSES_VERSION
  printf("\nncurses: %s (compiled with %s.%d)", curses_version(),
         NCURSES_VERSION, NCURSES_VERSION_PATCH);
#elif defined(USE_SLANG_CURSES)
  printf("\nslang: %s", SLANG_VERSION_STRING);
#endif

#ifdef _LIBICONV_VERSION
  printf("\nlibiconv: %d.%d", _LIBICONV_VERSION >> 8, _LIBICONV_VERSION & 0xff);
#endif

#ifdef HAVE_LIBIDN
  printf("\n%s", mutt_idna_print_version());
#endif

#ifdef CRYPT_BACKEND_GPGME
  printf("\nGPGme: %s", mutt_gpgme_print_version());
#endif

#ifdef USE_HCACHE
  const char *backends = mutt_hcache_backend_list();
  printf("\nhcache backends: %s", backends);
  FREE(&backends);
#endif

  puts("\n\nCompiler:");
  rstrip_in_place((char *) cc_version);
  puts((char *) cc_version);

  rstrip_in_place((char *) configure_options);
  printf("\nConfigure options: %s\n", (char *) configure_options);

  rstrip_in_place((char *) cc_cflags);
  printf("\nCompilation CFLAGS: %s\n", (char *) cc_cflags);

  printf("\n%s\n", _("Default options:"));
  print_compile_options(comp_opts_default);

  printf("\n%s\n", _("Compile options:"));
  print_compile_options(comp_opts);

#ifdef DOMAIN
  printf("DOMAIN=\"%s\"\n", DOMAIN);
#endif
#ifdef ISPELL
  printf("ISPELL=\"%s\"\n", ISPELL);
#endif
  printf("MAILPATH=\"%s\"\n", MAILPATH);
#ifdef MIXMASTER
  printf("MIXMASTER=\"%s\"\n", MIXMASTER);
#endif
  printf("PKGDATADIR=\"%s\"\n", PKGDATADIR);
  printf("SENDMAIL=\"%s\"\n", SENDMAIL);
  printf("SYSCONFDIR=\"%s\"\n", SYSCONFDIR);

  puts("");
  puts(_(ReachingUs));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void print_copyright

(

void

)

Print copyright message.

Print the authors' copyright messages, the GPL license and some contact information for the NeoMutt project.

Definition at line 445 of file version.c.

{
  puts(mutt_make_version());
  puts(Copyright);
  puts(_(Thanks));
  puts(_(License));
  puts(_(ReachingUs));
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool feature_enabled

(

const char *

name

)

Test if a compile-time feature is enabled.

Parameters

name	Compile-time symbol of the feature

Return values

true	Feature enabled
false	Feature not enabled, or not compiled in

Many of the larger features of neomutt can be disabled at compile time. They define a symbol and use ifdef's around their code. The symbols are mirrored in "CompileOptions comp_opts[]" in this file.

This function checks if one of these symbols is present in the code.

These symbols are also seen in the output of "neomutt -v".

Definition at line 469 of file version.c.

{
  if (!name)
    return false;
  for (int i = 0; comp_opts_default[i].name; i++)
  {
    if (mutt_str_strcmp(name, comp_opts_default[i].name) == 0)
    {
      return true;
    }
  }
  for (int i = 0; comp_opts[i].name; i++)
  {
    if (mutt_str_strcmp(name, comp_opts[i].name) == 0)
    {
      return comp_opts[i].enabled;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

const int SCREEN_WIDTH = 80

Definition at line 50 of file version.c.

unsigned char cc_version[]

unsigned char cc_cflags[]

unsigned char configure_options[]

const char* Copyright

static

Initial value:

=
    "Copyright (C) 1996-2016 Michael R. Elkins <me@mutt.org>\n"
    "Copyright (C) 1996-2002 Brandon Long <blong@fiction.net>\n"
    "Copyright (C) 1997-2009 Thomas Roessler <roessler@does-not-exist.org>\n"
    "Copyright (C) 1998-2005 Werner Koch <wk@isil.d.shuttle.de>\n"
    "Copyright (C) 1999-2017 Brendan Cully <brendan@kublai.com>\n"
    "Copyright (C) 1999-2002 Tommi Komulainen <Tommi.Komulainen@iki.fi>\n"
    "Copyright (C) 2000-2004 Edmund Grimley Evans <edmundo@rano.org>\n"
    "Copyright (C) 2006-2009 Rocco Rutte <pdmef@gmx.net>\n"
    "Copyright (C) 2014-2018 Kevin J. McCarthy <kevin@8t8.us>\n"
    "Copyright (C) 2015-2018 Richard Russon <rich@flatcap.org>\n"

Definition at line 56 of file version.c.

const char* Thanks

static

Initial value:

=
    N_("Many others not mentioned here contributed code, fixes,\n"
       "and suggestions.\n")

Definition at line 68 of file version.c.

const char* License

static

Initial value:

= N_(
    "    This program is free software; you can redistribute it and/or modify\n"
    "    it under the terms of the GNU General Public License as published by\n"
    "    the Free Software Foundation; either version 2 of the License, or\n"
    "    (at your option) any later version.\n"
    "\n"
    "    This program is distributed in the hope that it will be useful,\n"
    "    but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
    "    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n"
    "    GNU General Public License for more details.\n"
    "\n"
    "    You should have received a copy of the GNU General Public License\n"
    "    along with this program; if not, write to the Free Software\n"
    "    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  "
    "02110-1301, USA.\n")

Definition at line 72 of file version.c.

const char* ReachingUs

static

Initial value:

=
    N_("To learn more about NeoMutt, visit: https://neomutt.org\n"
       "If you find a bug in NeoMutt, please raise an issue at:\n"
       "    https://github.com/neomutt/neomutt/issues\n"
       "or send an email to: <neomutt-devel@neomutt.org>\n")

Definition at line 88 of file version.c.

const char* Notice

static

Initial value:

=
    N_("Copyright (C) 1996-2016 Michael R. Elkins and others.\n"
       "NeoMutt comes with ABSOLUTELY NO WARRANTY; for details type 'neomutt -vv'.\n"
       "NeoMutt is free software, and you are welcome to redistribute it\n"
       "under certain conditions; type 'neomutt -vv' for details.\n")

Definition at line 95 of file version.c.

struct CompileOptions comp_opts_default[]

static

Definition at line 113 of file version.c.

struct CompileOptions comp_opts[]

static

Definition at line 147 of file version.c.