NeoMutt  2020-03-20-65-g141838
Teaching an old dog new tricks
DOXYGEN
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/lib.h"
#include "gui/lib.h"
#include "version.h"
#include "compress/lib.h"
#include "ncrypt/lib.h"
#include <openssl/opensslv.h>
#include <gnutls/gnutls.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 * store_backend_list (void)
 Get a list of backend names. More...
 
const char * store_compress_list (void)
 
static void print_compile_options (struct CompileOptions *co, FILE *fp)
 Print a list of enabled/disabled features. More...
 
static char * rstrip_in_place (char *s)
 Strip a trailing carriage return. More...
 
void print_version (FILE *fp)
 Print system and compile info to a file. 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_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

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

◆ mutt_make_version()

const char* mutt_make_version ( void  )

Generate the NeoMutt version string.

Return values
ptrVersion string
Note
This returns a pointer to a static buffer

Definition at line 1549 of file muttlib.c.

1550 {
1551  static char vstring[256];
1552  snprintf(vstring, sizeof(vstring), "NeoMutt %s%s", PACKAGE_VERSION, GitVer);
1553  return vstring;
1554 }
const char * GitVer
+ Here is the caller graph for this function:

◆ store_backend_list()

const char* store_backend_list ( void  )

Get a list of backend names.

Return values
ptrComma-space-separated list of names

The caller should free the string.

Definition at line 80 of file store.c.

81 {
82  char tmp[256] = { 0 };
83  const struct StoreOps **ops = store_ops;
84  size_t len = 0;
85 
86  for (; *ops; ops++)
87  {
88  if (len != 0)
89  {
90  len += snprintf(tmp + len, sizeof(tmp) - len, ", ");
91  }
92  len += snprintf(tmp + len, sizeof(tmp) - len, "%s", (*ops)->name);
93  }
94 
95  return mutt_str_strdup(tmp);
96 }
Key Value Store API.
Definition: lib.h:60
char * mutt_str_strdup(const char *str)
Copy a string, safely.
Definition: string.c:380
const struct StoreOps * store_ops[]
Backend implementations.
Definition: store.c:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ store_compress_list()

const char* store_compress_list ( void  )

◆ print_compile_options()

static void print_compile_options ( struct CompileOptions co,
FILE *  fp 
)
static

Print a list of enabled/disabled features.

Parameters
coArray of compile options
fpfile to write to

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 356 of file version.c.

357 {
358  if (!co || !fp)
359  return;
360 
361  size_t used = 2;
362  bool tty = isatty(fileno(fp));
363 
364  fprintf(fp, " ");
365  for (int i = 0; co[i].name; i++)
366  {
367  const size_t len = strlen(co[i].name) + 2; /* +/- and a space */
368  if ((used + len) > SCREEN_WIDTH)
369  {
370  used = 2;
371  fprintf(fp, "\n ");
372  }
373  used += len;
374  const char *fmt = "?%s ";
375  switch (co[i].enabled)
376  {
377  case 0: // Disabled
378  if (tty)
379  fmt = "\033[1;31m-%s\033[0m "; // Escape, red
380  else
381  fmt = "-%s ";
382  break;
383  case 1: // Enabled
384  if (tty)
385  fmt = "\033[1;32m+%s\033[0m "; // Escape, green
386  else
387  fmt = "+%s ";
388  break;
389  case 2: // Devel only
390  if (tty)
391  fmt = "\033[1;36m!%s\033[0m "; // Escape, cyan
392  else
393  fmt = "!%s ";
394  break;
395  }
396  fprintf(fp, fmt, co[i].name);
397  }
398  fprintf(fp, "\n");
399 }
static int const char * fmt
Definition: acutest.h:473
const char * name
Definition: version.c:119
const char * name
Definition: pgpmicalg.c:46
const int SCREEN_WIDTH
Definition: version.c:63
+ Here is the caller graph for this function:

◆ rstrip_in_place()

static char* rstrip_in_place ( char *  s)
static

Strip a trailing carriage return.

Parameters
sString to be modified
Return values
ptrThe modified string

The string has its last carriage return set to NUL.

Definition at line 408 of file version.c.

409 {
410  if (!s)
411  return NULL;
412 
413  char *p = &s[strlen(s)];
414  if (p == s)
415  return s;
416  p--;
417  while ((p >= s) && ((*p == '\n') || (*p == '\r')))
418  *p-- = '\0';
419  return s;
420 }
+ Here is the caller graph for this function:

◆ print_version()

void print_version ( FILE *  fp)

Print system and compile info to a file.

Parameters
fp- file to print to

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

Definition at line 429 of file version.c.

430 {
431  if (!fp)
432  return;
433 
434  struct utsname uts;
435  bool tty = isatty(fileno(fp));
436  const char *fmt = "%s\n";
437 
438  if (tty)
439  fmt = "\033[1;36m%s\033[0m\n"; // Escape, cyan
440 
441  fprintf(fp, fmt, mutt_make_version());
442  fprintf(fp, "%s\n", _(Notice));
443 
444  uname(&uts);
445 
446 #ifdef SCO
447  fprintf(fp, "System: SCO %s", uts.release);
448 #else
449  fprintf(fp, "System: %s %s", uts.sysname, uts.release);
450 #endif
451 
452  fprintf(fp, " (%s)", uts.machine);
453 
454 #ifdef NCURSES_VERSION
455  fprintf(fp, "\nncurses: %s (compiled with %s.%d)", curses_version(),
456  NCURSES_VERSION, NCURSES_VERSION_PATCH);
457 #elif defined(USE_SLANG_CURSES)
458  fprintf(fp, "\nslang: %s", SLANG_VERSION_STRING);
459 #endif
460 
461 #ifdef _LIBICONV_VERSION
462  fprintf(fp, "\nlibiconv: %d.%d", _LIBICONV_VERSION >> 8, _LIBICONV_VERSION & 0xff);
463 #endif
464 
465 #ifdef HAVE_LIBIDN
466  fprintf(fp, "\n%s", mutt_idna_print_version());
467 #endif
468 
469 #ifdef CRYPT_BACKEND_GPGME
470  fprintf(fp, "\nGPGME: %s", mutt_gpgme_print_version());
471 #endif
472 
473 #ifdef USE_SSL_OPENSSL
474 #ifdef LIBRESSL_VERSION_TEXT
475  fprintf(fp, "\nLibreSSL: %s", LIBRESSL_VERSION_TEXT);
476 #endif
477 #ifdef OPENSSL_VERSION_TEXT
478  fprintf(fp, "\nOpenSSL: %s", OPENSSL_VERSION_TEXT);
479 #endif
480 #endif
481 
482 #ifdef USE_SSL_GNUTLS
483  fprintf(fp, "\nGnuTLS: %s", GNUTLS_VERSION);
484 #endif
485 
486 #ifdef HAVE_NOTMUCH
487  fprintf(fp, "\nlibnotmuch: %d.%d.%d", LIBNOTMUCH_MAJOR_VERSION,
488  LIBNOTMUCH_MINOR_VERSION, LIBNOTMUCH_MICRO_VERSION);
489 #endif
490 
491 #ifdef USE_HCACHE
492  const char *backends = store_backend_list();
493  fprintf(fp, "\nstorage: %s", backends);
494  FREE(&backends);
495 #ifdef USE_HCACHE_COMPRESSION
496  backends = compress_list();
497  fprintf(fp, "\ncompression: %s", backends);
498  FREE(&backends);
499 #endif
500 #endif
501 
503  fprintf(fp, "\n\nConfigure options: %s\n", (char *) configure_options);
504 
505  rstrip_in_place((char *) cc_cflags);
506  fprintf(fp, "\nCompilation CFLAGS: %s\n", (char *) cc_cflags);
507 
508  fprintf(fp, "\n%s\n", _("Default options:"));
510 
511  fprintf(fp, "\n%s\n", _("Compile options:"));
513 
514 #ifdef DOMAIN
515  fprintf(fp, "DOMAIN=\"%s\"\n", DOMAIN);
516 #endif
517 #ifdef ISPELL
518  fprintf(fp, "ISPELL=\"%s\"\n", ISPELL);
519 #endif
520  fprintf(fp, "MAILPATH=\"%s\"\n", MAILPATH);
521 #ifdef MIXMASTER
522  fprintf(fp, "MIXMASTER=\"%s\"\n", MIXMASTER);
523 #endif
524  fprintf(fp, "PKGDATADIR=\"%s\"\n", PKGDATADIR);
525  fprintf(fp, "SENDMAIL=\"%s\"\n", SENDMAIL);
526  fprintf(fp, "SYSCONFDIR=\"%s\"\n", SYSCONFDIR);
527 
528  fprintf(fp, "\n");
529  fputs(_(ReachingUs), fp);
530 }
unsigned char configure_options[]
static struct CompileOptions comp_opts[]
Definition: version.c:159
static int const char * fmt
Definition: acutest.h:473
#define _(a)
Definition: message.h:28
#define ISPELL
Definition: mutt_config.c:89
const char * store_backend_list(void)
Get a list of backend names.
Definition: store.c:80
static struct CompileOptions comp_opts_default[]
Definition: version.c:125
static char * rstrip_in_place(char *s)
Strip a trailing carriage return.
Definition: version.c:408
static const char * ReachingUs
Definition: version.c:100
unsigned char cc_cflags[]
const char * compress_list(void)
Get a list of compression backend names.
Definition: compress.c:64
const char * mutt_gpgme_print_version(void)
Get version of GPGME.
Definition: crypt_gpgme.c:5872
const char * mutt_idna_print_version(void)
Create an IDN version string.
Definition: idna.c:313
#define FREE(x)
Definition: memory.h:40
static void print_compile_options(struct CompileOptions *co, FILE *fp)
Print a list of enabled/disabled features.
Definition: version.c:356
const char * mutt_make_version(void)
Generate the NeoMutt version string.
Definition: muttlib.c:1549
static const char * Notice
Definition: version.c:107
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ print_copyright()

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 538 of file version.c.

539 {
540  puts(mutt_make_version());
541  puts(Copyright);
542  puts(_(Thanks));
543  puts(_(License));
544  puts(_(ReachingUs));
545 }
#define _(a)
Definition: message.h:28
static const char * Copyright
Definition: version.c:68
static const char * ReachingUs
Definition: version.c:100
static const char * Thanks
Definition: version.c:80
const char * mutt_make_version(void)
Generate the NeoMutt version string.
Definition: muttlib.c:1549
static const char * License
Definition: version.c:84
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ feature_enabled()

bool feature_enabled ( const char *  name)

Test if a compile-time feature is enabled.

Parameters
nameCompile-time symbol of the feature
Return values
trueFeature enabled
falseFeature 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 562 of file version.c.

563 {
564  if (!name)
565  return false;
566  for (int i = 0; comp_opts_default[i].name; i++)
567  {
569  {
570  return true;
571  }
572  }
573  for (int i = 0; comp_opts[i].name; i++)
574  {
575  if (mutt_str_strcmp(name, comp_opts[i].name) == 0)
576  {
577  return comp_opts[i].enabled;
578  }
579  }
580  return false;
581 }
static struct CompileOptions comp_opts[]
Definition: version.c:159
const char * name
Definition: version.c:119
static struct CompileOptions comp_opts_default[]
Definition: version.c:125
const char * name
Definition: pgpmicalg.c:46
int mutt_str_strcmp(const char *a, const char *b)
Compare two strings, safely.
Definition: string.c:638
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ SCREEN_WIDTH

const int SCREEN_WIDTH = 80

Definition at line 63 of file version.c.

◆ cc_cflags

unsigned char cc_cflags[]

◆ configure_options

unsigned char configure_options[]

◆ Copyright

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-2019 Kevin J. McCarthy <kevin@8t8.us>\n"
"Copyright (C) 2015-2019 Richard Russon <rich@flatcap.org>\n"

Definition at line 68 of file version.c.

◆ Thanks

const char* Thanks
static
Initial value:
=
N_("Many others not mentioned here contributed code, fixes,\n"
"and suggestions.\n")
#define N_(a)
Definition: message.h:32

Definition at line 80 of file version.c.

◆ License

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")
#define N_(a)
Definition: message.h:32

Definition at line 84 of file version.c.

◆ ReachingUs

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")
#define N_(a)
Definition: message.h:32

Definition at line 100 of file version.c.

◆ Notice

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")
#define N_(a)
Definition: message.h:32

Definition at line 107 of file version.c.

◆ comp_opts_default

struct CompileOptions comp_opts_default[]
static

Definition at line 125 of file version.c.

◆ comp_opts

struct CompileOptions comp_opts[]
static

Definition at line 159 of file version.c.