version.h File Reference

Display version and copyright about NeoMutt. More...

#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"

Include dependency graph for version.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	KeyValue
	Key/Value pairs. More...
struct	CompileOption
	Built-in capability. More...
struct	NeoMuttVersion
	Version info about NeoMutt. More...

Functions
	ARRAY_HEAD (KeyValueArray, struct KeyValue)
struct NeoMuttVersion *	version_get (void)
	Get NeoMutt version info.
void	version_free (struct NeoMuttVersion **ptr)
	Free a NeoMuttVersion.
const char *	mutt_make_version (void)
	Generate the NeoMutt version string.
bool	print_version (FILE *fp, bool use_ansi)
	Print system and compile info to a file.
bool	print_copyright (void)
	Print copyright message.
bool	feature_enabled (const char *name)
	Test if a compile-time feature is enabled.

Detailed Description

Display version and copyright about NeoMutt.

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 version.h.

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	KeyValueArray	,
		struct KeyValue	)

version_get()

struct NeoMuttVersion * version_get

(

void

)

Get NeoMutt version info.

Return values

ptr	NeoMuttVersion

Definition at line 469 of file version.c.

{
  struct NeoMuttVersion *ver = MUTT_MEM_CALLOC(1, struct NeoMuttVersion);
 
  ver->version = mutt_str_dup(mutt_make_version());
 
  ARRAY_INIT(&ver->system);
  system_get(&ver->system);
 
#ifdef USE_HCACHE
  ver->storage = store_backend_list();
#ifdef USE_HCACHE_COMPRESSION
  ver->compression = compress_list();
#endif
#endif
 
  rstrip_in_place((char *) configure_options);
  ver->configure = slist_parse((char *) configure_options, D_SLIST_SEP_SPACE);
 
  rstrip_in_place((char *) cc_cflags);
  ver->compilation = slist_parse((char *) cc_cflags, D_SLIST_SEP_SPACE);
 
  ver->feature = CompOpts;
 
  if (DevelOpts[0].name)
    ver->devel = DevelOpts;
 
  ARRAY_INIT(&ver->paths);
  paths_get(&ver->paths);
 
  return ver;
}

Here is the call graph for this function:

Here is the caller graph for this function:

version_free()

void version_free

(

struct NeoMuttVersion **

ptr

)

Free a NeoMuttVersion.

Parameters

ptr	NeoMuttVersion to free

Definition at line 506 of file version.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct NeoMuttVersion *ver = *ptr;
 
  FREE(&ver->version);
 
  kva_clear(&ver->system);
  kva_clear(&ver->paths);
 
  slist_free(&ver->storage);
  slist_free(&ver->compression);
  slist_free(&ver->configure);
  slist_free(&ver->compilation);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_make_version()

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

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

Here is the caller graph for this function:

print_version()

bool print_version	(	FILE *	fp,
		bool	use_ansi )

Print system and compile info to a file.

Parameters

fp	File to print to
use_ansi	Use ANSI colour escape sequences

Return values

true	Text displayed

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

Definition at line 591 of file version.c.

{
  if (!fp)
    return false;
 
  struct KeyValue *kv = NULL;
  struct ListNode *np = NULL;
  struct NeoMuttVersion *ver = version_get();
 
  const char *col_cyan = "";
  const char *col_bold = "";
  const char *col_end = "";
 
  if (use_ansi)
  {
    col_cyan = "\033[1;36m"; // Escape, cyan
    col_bold = "\033[1m";    // Escape, bold
    col_end = "\033[0m";     // Escape, end
  }
 
  fprintf(fp, "%s%s%s\n", col_cyan, ver->version, col_end);
  fprintf(fp, "%s\n", _(Notice));
 
  ARRAY_FOREACH(kv, &ver->system)
  {
    fprintf(fp, "%s%s:%s %s\n", col_bold, kv->key, col_end, kv->value);
  }
 
  if (ver->storage)
  {
    fprintf(fp, "%sstorage:%s ", col_bold, col_end);
    STAILQ_FOREACH(np, &ver->storage->head, entries)
    {
      fputs(np->data, fp);
      if (STAILQ_NEXT(np, entries))
        fputs(", ", fp);
    }
    fputs("\n", fp);
  }
 
  if (ver->compression)
  {
    fprintf(fp, "%scompression:%s ", col_bold, col_end);
    STAILQ_FOREACH(np, &ver->compression->head, entries)
    {
      fputs(np->data, fp);
      if (STAILQ_NEXT(np, entries))
        fputs(", ", fp);
    }
    fputs("\n", fp);
  }
  fputs("\n", fp);
 
  fprintf(fp, "%sConfigure options:%s ", col_bold, col_end);
  if (ver->configure)
  {
    STAILQ_FOREACH(np, &ver->configure->head, entries)
    {
      if (!np || !np->data)
        continue;
      fputs(np->data, fp);
      if (STAILQ_NEXT(np, entries))
        fputs(" ", fp);
    }
  }
  fputs("\n\n", fp);
 
  if (ver->compilation)
  {
    fprintf(fp, "%sCompilation CFLAGS:%s ", col_bold, col_end);
    STAILQ_FOREACH(np, &ver->compilation->head, entries)
    {
      if (!np || !np->data)
        continue;
      fputs(np->data, fp);
      if (STAILQ_NEXT(np, entries))
        fputs(" ", fp);
    }
    fputs("\n\n", fp);
  }
 
  fprintf(fp, "%s%s%s\n", col_bold, _("Compile options:"), col_end);
  print_compile_options(ver->feature, fp, use_ansi);
  fputs("\n", fp);
 
  if (ver->devel)
  {
    fprintf(fp, "%s%s%s\n", col_bold, _("Devel options:"), col_end);
    print_compile_options(ver->devel, fp, use_ansi);
    fputs("\n", fp);
  }
 
  ARRAY_FOREACH(kv, &ver->paths)
  {
    fprintf(fp, "%s%s%s=\"%s\"\n", col_bold, kv->key, col_end, kv->value);
  }
  fputs("\n", fp);
 
  fputs(_(ReachingUs), fp);
 
  version_free(&ver);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_copyright()

bool print_copyright

(

void

)

Print copyright message.

Return values

true	Text displayed

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

Definition at line 702 of file version.c.

{
  puts(mutt_make_version());
  puts(Copyright);
  puts(_(Thanks));
  puts(_(License));
  puts(_(ReachingUs));
 
  fflush(stdout);
  return !ferror(stdout);
}

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

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 "CompileOption CompOpts[]" 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 729 of file version.c.

{
  if (!name)
    return false;
  for (int i = 0; CompOpts[i].name; i++)
  {
    if (mutt_str_equal(name, CompOpts[i].name))
    {
      return CompOpts[i].enabled;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function: