neovim/src/nvim/version.c

/// @file version.c
///
/// Nvim was forked from Vim 7.4.160.
/// Vim originated from Stevie version 3.6 (Fish disk 217) by GRWalter (Fred).

#include <inttypes.h>

#include "nvim/vim.h"
#include "nvim/ascii.h"
#include "nvim/iconv.h"
#include "nvim/version.h"
#include "nvim/charset.h"
#include "nvim/memline.h"
#include "nvim/memory.h"
#include "nvim/message.h"
#include "nvim/misc2.h"
#include "nvim/screen.h"
#include "nvim/strings.h"
#include "nvim/version_defs.h"

char *Version = VIM_VERSION_SHORT;
char *longVersion = NVIM_VERSION_LONG " (compiled " __DATE__ " " __TIME__ ")";
char *version_commit = "Commit: " NVIM_VERSION_COMMIT;
char *version_buildtype = "Build type: " NVIM_VERSION_BUILD_TYPE;
char *version_cflags = "Compilation: " NVIM_VERSION_CFLAGS;

#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "version.c.generated.h"
#endif
static char *(features[]) = {
#ifdef HAVE_ACL
  "+acl",
#else  // ifdef HAVE_ACL
  "-acl",
#endif  // ifdef HAVE_ACL
  "+arabic",
  "+autocmd",
  "-browse",
#ifdef NO_BUILTIN_TCAPS
  "-builtin_terms",
#endif  // ifdef NO_BUILTIN_TCAPS
#ifdef SOME_BUILTIN_TCAPS
  "+builtin_terms",
#endif  // ifdef SOME_BUILTIN_TCAPS
#ifdef ALL_BUILTIN_TCAPS
  "++builtin_terms",
#endif  // ifdef ALL_BUILTIN_TCAPS
  "+byte_offset",
  "+cindent",
  "-clipboard",
  "+cmdline_compl",
  "+cmdline_hist",
  "+cmdline_info",
  "+comments",
  "+conceal",
  "+cscope",
  "+cursorbind",
  "+cursorshape",
  "+dialog_con",
  "+diff",
  "+digraphs",
  "-dnd",
  "-ebcdic",
  "-emacs_tags",
  "+eval",
  "+ex_extra",
  "+extra_search",
  "+farsi",
  "+file_in_path",
  "+find_in_path",
  "+float",
  "+folding",
  "-footer",

  // only interesting on Unix systems
#if defined(UNIX)
  "+fork()",
#endif  // if defined(UNIX)
  "+gettext",
#if (defined(HAVE_ICONV_H) && defined(USE_ICONV)) || defined(DYNAMIC_ICONV)
# ifdef DYNAMIC_ICONV
  "+iconv/dyn",
# else  // ifdef DYNAMIC_ICONV
  "+iconv",
# endif  // ifdef DYNAMIC_ICONV
#else  // if (defined(HAVE_ICONV_H) && defined(USE_ICONV))
       //    ||defined(DYNAMIC_ICONV)
  "-iconv",
#endif  // if (defined(HAVE_ICONV_H) && defined(USE_ICONV))
        //    || defined(DYNAMIC_ICONV)
  "+insert_expand",
  "+jumplist",
  "+keymap",
  "+langmap",
  "+libcall",
  "+linebreak",
  "+lispindent",
  "+listcmds",
  "+localmap",
  "+menu",
  "+mksession",
  "+modify_fname",
  "+mouse",
  "-mouseshape",

#if defined(UNIX)
  "+mouse_dec",
  "-mouse_gpm",
  "+mouse_netterm",
#endif  // if defined(UNIX)


#if defined(UNIX)
  "+mouse_sgr",
  "-mouse_sysmouse",
  "+mouse_urxvt",
  "+mouse_xterm",
#endif  // if defined(UNIX)

  "+multi_byte",
  "+multi_lang",
  "+path_extra",
  "+persistent_undo",
  "+postscript",
  "+printer",
  "+profile",
  "+quickfix",
  "+reltime",
  "+rightleft",
  "+scrollbind",
  "+signs",
  "+smartindent",
  "+startuptime",
  "+statusline",
  "+syntax",
  "+tag_binary",
  "+tag_old_static",
  "-tag_any_white",
#if defined(UNIX)

  // only Unix can have terminfo instead of termcap
# ifdef TERMINFO
  "+terminfo",
# else // ifdef TERMINFO
  "-terminfo",
# endif // ifdef TERMINFO
#else   // unix always includes termcap support
# ifdef HAVE_TGETENT
  "+tgetent",
# else  // ifdef HAVE_TGETENT
  "-tgetent",
# endif  // ifdef HAVE_TGETENT
#endif  // if defined(UNIX)
  "+termresponse",
  "+textobjects",
  "+title",
  "-toolbar",
  "+user_commands",
  "+vertsplit",
  "+virtualedit",
  "+visual",
  "+visualextra",
  "+viminfo",
  "+vreplace",
  "+wildignore",
  "+wildmenu",
  "+windows",
  "+writebackup",
#if defined(UNIX)
  "-X11",
#endif  // if defined(UNIX)
  "-xfontset",
#if defined(UNIX)
  "-xsmp",
  "-xterm_clipboard",
#endif  // if defined(UNIX)
  NULL
};

static int included_patches[] = {
  //488,
  //487,
  //486,
  //485,
  //484,
  //483,
  //482,
  //481,
  //480,
  //479,
  //478,
  //477,
  //476,
  //475,
  //474,
  //473,
  //472,
  //471,
  //470,
  //469,
  //468,
  //467,
  //465,
  //464,
  //463,
  //462,
  //461,
  //460,
  //459,
  //458,
  //457,
  //456,
  //455,
  454,
  //453,
  //452,
  //451,
  //450,
  //449,
  //448,
  //447,
  //446,
  //445,
  444,
  //443,
  //442,
  //441,
  440,
  439,
  //438,
  //437,
  436,
  //435,
  //434,
  433,
  //432 NA
  //431 NA
  //430 NA
  //429 NA
  //428 NA
  427,
  //426 NA
  //425,
  //424 NA
  //423,
  //422,
  //421,
  //420 NA
  //419,
  418,
  //417,
  //416,
  //415,
  414,
  //413 NA
  //412 NA
  411,
  410,
  //409 NA
  408,
  407,
  406,
  405,
  //404 NA
  //403 NA
  //402,
  //401 NA
  //400 NA
  //399 NA
  //398 NA
  397,
  //396,
  //395,
  //394 NA
  //393 NA
  392,
  391,
  //390,
  //389,
  388,
  387,
  386,
  //385,
  //384 NA
  383,
  382,
  381,
  //380 NA
  379,
  //378,
  377,
  376,
  375,
  374,
  373,
  372,
  371,
  370,
  369,
  368,
  367,
  //366 NA
  365,
  364,
  //363 NA
  362,
  361,
  360,
  359,
  358,
  357,
  //356 NA
  //355,
  //354 NA
  353,
  352,
  351,
  //350,
  349,
  348,
  347,
  346,
  345,
  344,
  343,
  //342 NA
  341,
  //340 NA
  339,
  338,
  337,
  //336,
  335,
  334,
  //333 NA
  //332 NA
  331,
  330,
  329,
  328,
  327,
  //326 NA
  325,
  //324,
  323,
  //322 NA
  //321 NA
  320,
  //319 NA
  318,
  317,
  //316 NA
  315,
  314,
  313,
  312,
  //311,
  310,
  309,
  308,
  //307 NA
  306,
  305,
  //304 NA
  303,
  302,
  301,
  //300 NA
  //299 NA
  298,
  297,
  296,
  295,
  294,
  293,
  292,
  291,
  290,
  289,
  288,
  //287 NA
  286,
  285,
  284,
  //283 NA
  282,
  281,
  280,
  279,
  278,
  277,
  276,
  275,
  274,
  //273 NA
  272,
  //271 NA
  //270 NA
  269,
  268,
  267,
  266,
  265,
  264,
  //263 NA
  262,
  261,
  260,
  //259 NA
  //258 NA
  //257 NA
  256,
  //255,
  //254,
  253,
  //252 NA
  251,
  //250 NA
  //249,
  248,
  247,
  //246,
  245,
  //244,
  //243,
  //242,
  241,
  240,
  239,
  //238,
  237,
  236,
  235,
  234,
  233,
  232,
  231,
  230,
  229,
  //228 NA
  //227 NA
  226,
  //225 NA
  //224 NA
  //223 NA
  //222 NA
  221,
  220,
  219,
  218,
  //217 NA
  //216 NA
  215,
  //214 NA
  213,
  //212 NA
  //211,
  210,
  209,
  //208 NA
  207,
  //206 NA
  205,
  204,
  203,
  //202 NA
  201,
  //200 NA
  199,
  //198 NA
  //197 NA
  //196 NA
  //195 NA
  //194 NA
  193,
  192,
  191,
  //190 NA
  //189 NA
  //188 NA
  187,
  186,
  //185 NA
  184,
  //183 NA
  //182 NA
  181,
  //180 NA
  //179 NA
  178,
  //177 NA
  //176 NA
  //175 NA
  //174 NA
  173,
  172,
  171,
  170,
  169,
  //168 NA
  167,
  166,
  165,
  //164 NA
  //163 NA
  //162 NA
  //161 NA
  160,
  159,
  158,
  157,
  156,
  155,
  154,
  153,
  152,
  151,
  150,
  149,
  148,
  147,
  146,
  145,
  144,
  143,
  142,
  141,
  140,
  139,
  138,
  137,
  136,
  135,
  134,
  133,
  132,
  131,
  130,
  129,
  128,
  127,
  126,
  125,
  124,
  123,
  122,
  121,
  120,
  119,
  118,
  117,
  116,
  115,
  114,
  113,
  112,
  111,
  110,
  109,
  108,
  107,
  106,
  105,
  104,
  103,
  102,
  101,
  100,
  99,
  98,
  97,
  96,
  95,
  94,
  93,
  92,
  91,
  90,
  89,
  88,
  87,
  86,
  85,
  84,
  83,
  82,
  81,
  80,
  79,
  78,
  77,
  76,
  75,
  74,
  73,
  72,
  71,
  70,
  69,
  68,
  67,
  66,
  65,
  64,
  63,
  62,
  61,
  60,
  59,
  58,
  57,
  56,
  55,
  54,
  53,
  52,
  51,
  50,
  49,
  48,
  47,
  46,
  45,
  44,
  43,
  42,
  41,
  40,
  39,
  38,
  37,
  36,
  35,
  34,
  33,
  32,
  31,
  30,
  29,
  28,
  27,
  26,
  25,
  24,
  23,
  22,
  21,
  20,
  19,
  18,
  17,
  16,
  15,
  14,
  13,
  12,
  11,
  10,
  9,
  8,
  7,
  6,
  5,
  4,
  3,
  2,
  1,
  0
};

/// Place to put a short description when adding a feature with a patch.
/// Keep it short, e.g.,: "relative numbers", "persistent undo".
/// Also add a comment marker to separate the lines.
/// See the official Vim patches for the diff format: It must use a context of
/// one line only.  Create it by hand or use "diff -C2" and edit the patch.
static char *(extra_patches[]) = {
  // Add your patch description below this line
  NULL
};

int highest_patch(void)
{
  int i;
  int h = 0;

  for (i = 0; included_patches[i] != 0; ++i) {
    if (included_patches[i] > h) {
      h = included_patches[i];
    }
  }
  return h;
}

/// Checks whether patch `n` has been included.
///
/// @param n The patch number.
///
/// @return TRUE if patch "n" has been included.
int has_patch(int n)
{
  int i;
  for (i = 0; included_patches[i] != 0; ++i) {
    if (included_patches[i] == n) {
      return TRUE;
    }
  }
  return FALSE;
}

void ex_version(exarg_T *eap)
{
  // Ignore a ":version 9.99" command.
  if (*eap->arg == NUL) {
    msg_putchar('\n');
    list_version();
  }
}

/// List all features aligned in columns, dictionary style.
static void list_features(void)
{
  int nfeat = 0;
  int width = 0;

  // Find the length of the longest feature name, use that + 1 as the column
  // width
  int i;
  for (i = 0; features[i] != NULL; ++i) {
    int l = (int)STRLEN(features[i]);

    if (l > width) {
      width = l;
    }
    nfeat++;
  }
  width += 1;

  if (Columns < width) {
    // Not enough screen columns - show one per line
    for (i = 0; features[i] != NULL; ++i) {
      version_msg(features[i]);
      if (msg_col > 0) {
        msg_putchar('\n');
      }
    }
    return;
  }

  // The rightmost column doesn't need a separator.
  // Sacrifice it to fit in one more column if possible.
  int ncol = (int)(Columns + 1) / width;
  int nrow = nfeat / ncol + (nfeat % ncol ? 1 : 0);

  // i counts columns then rows.  idx counts rows then columns.
  for (i = 0; !got_int && i < nrow * ncol; ++i) {
    int idx = (i / ncol) + (i % ncol) * nrow;
    if (idx < nfeat) {
      int last_col = (i + 1) % ncol == 0;
      msg_puts((char_u *)features[idx]);
      if (last_col) {
        if (msg_col > 0) {
          msg_putchar('\n');
        }
      } else {
        while (msg_col % width) {
          msg_putchar(' ');
        }
      }
    } else {
      if (msg_col > 0) {
        msg_putchar('\n');
      }
    }
  }
}

void list_version(void)
{
  // When adding features here, don't forget to update the list of
  // internal variables in eval.c!
  MSG(longVersion);
  MSG(version_commit);
  MSG(version_buildtype);
  MSG(version_cflags);

  // Print the list of extra patch descriptions if there is at least one.
  char *s = "";
  if (extra_patches[0] != NULL) {
    MSG_PUTS(_("\nExtra patches: "));
    s = "";

    for (int i = 0; extra_patches[i] != NULL; ++i) {
      MSG_PUTS(s);
      s = ", ";
      MSG_PUTS(extra_patches[i]);
    }
  }

#ifdef HAVE_PATHDEF

  if ((*compiled_user != NUL) || (*compiled_sys != NUL)) {
    MSG_PUTS(_("\nCompiled "));

    if (*compiled_user != NUL) {
      MSG_PUTS(_("by "));
      MSG_PUTS(compiled_user);
    }

    if (*compiled_sys != NUL) {
      MSG_PUTS("@");
      MSG_PUTS(compiled_sys);
    }
  }
#endif  // ifdef HAVE_PATHDEF

  version_msg(_("  Features included (+) or not (-):\n"));

  list_features();

#ifdef SYS_VIMRC_FILE
  version_msg(_("   system vimrc file: \""));
  version_msg(SYS_VIMRC_FILE);
  version_msg("\"\n");
#endif  // ifdef SYS_VIMRC_FILE
#ifdef USR_VIMRC_FILE
  version_msg(_("     user vimrc file: \""));
  version_msg(USR_VIMRC_FILE);
  version_msg("\"\n");
#endif  // ifdef USR_VIMRC_FILE
#ifdef USR_VIMRC_FILE2
  version_msg(_(" 2nd user vimrc file: \""));
  version_msg(USR_VIMRC_FILE2);
  version_msg("\"\n");
#endif  // ifdef USR_VIMRC_FILE2
#ifdef USR_VIMRC_FILE3
  version_msg(_(" 3rd user vimrc file: \""));
  version_msg(USR_VIMRC_FILE3);
  version_msg("\"\n");
#endif  // ifdef USR_VIMRC_FILE3
#ifdef USR_EXRC_FILE
  version_msg(_("      user exrc file: \""));
  version_msg(USR_EXRC_FILE);
  version_msg("\"\n");
#endif  // ifdef USR_EXRC_FILE
#ifdef USR_EXRC_FILE2
  version_msg(_("  2nd user exrc file: \""));
  version_msg(USR_EXRC_FILE2);
  version_msg("\"\n");
#endif  // ifdef USR_EXRC_FILE2
#ifdef HAVE_PATHDEF

  if (*default_vim_dir != NUL) {
    version_msg(_("  fall-back for $VIM: \""));
    version_msg((char *)default_vim_dir);
    version_msg("\"\n");
  }

  if (*default_vimruntime_dir != NUL) {
    version_msg(_(" f-b for $VIMRUNTIME: \""));
    version_msg((char *)default_vimruntime_dir);
    version_msg("\"\n");
  }
#endif  // ifdef HAVE_PATHDEF
}

/// Output a string for the version message.  If it's going to wrap, output a
/// newline, unless the message is too long to fit on the screen anyway.
///
/// @param s
static void version_msg(char *s)
{
  int len = (int)STRLEN(s);

  if (!got_int
      && (len < (int)Columns)
      && (msg_col + len >= (int)Columns)
      && (*s != '\n')) {
    msg_putchar('\n');
  }

  if (!got_int) {
    MSG_PUTS(s);
  }
}


/// Show the intro message when not editing a file.
void maybe_intro_message(void)
{
  if (bufempty()
      && (curbuf->b_fname == NULL)
      && (firstwin->w_next == NULL)
      && (vim_strchr(p_shm, SHM_INTRO) == NULL)) {
    intro_message(FALSE);
  }
}

/// Give an introductory message about Vim.
/// Only used when starting Vim on an empty file, without a file name.
/// Or with the ":intro" command (for Sven :-).
///
/// @param colon TRUE for ":intro"
void intro_message(int colon)
{
  int i;
  int row;
  int blanklines;
  int sponsor;
  char *p;
  static char *(lines[]) = {
    N_(NVIM_VERSION_LONG),
    "",
    N_("by Bram Moolenaar et al."),
    N_("Vim is open source and freely distributable"),
    "",
    N_("Help poor children in Uganda!"),
    N_("type  :help iccf<Enter>       for information "),
    "",
    N_("type  :q<Enter>               to exit         "),
    N_("type  :help<Enter>  or  <F1>  for on-line help"),
    N_("type  :help nvim<Enter>       for Neovim help "),
  };

  // blanklines = screen height - # message lines
  blanklines = (int)Rows - ((sizeof(lines) / sizeof(char *)) - 1);

  // Don't overwrite a statusline.  Depends on 'cmdheight'.
  if (p_ls > 1) {
    blanklines -= Rows - topframe->fr_height;
  }

  if (blanklines < 0) {
    blanklines = 0;
  }

  // Show the sponsor and register message one out of four times, the Uganda
  // message two out of four times.
  sponsor = (int)time(NULL);
  sponsor = ((sponsor & 2) == 0) - ((sponsor & 4) == 0);

  // start displaying the message lines after half of the blank lines
  row = blanklines / 2;

  if (((row >= 2) && (Columns >= 50)) || colon) {
    for (i = 0; i < (int)(sizeof(lines) / sizeof(char *)); ++i) {
      p = lines[i];
      if (p == NULL) {
        if (!p_cp) {
          break;
        }
        continue;
      }

      if (sponsor != 0) {
        if (strstr(p, "children") != NULL) {
          p = sponsor < 0
              ? N_("Sponsor Vim development!")
              : N_("Become a registered Vim user!");
        } else if (strstr(p, "iccf") != NULL) {
          p = sponsor < 0
              ? N_("type  :help sponsor<Enter>    for information ")
              : N_("type  :help register<Enter>   for information ");
        } else if (strstr(p, "Orphans") != NULL) {
          p = N_("menu  Help->Sponsor/Register  for information    ");
        }
      }

      if (*p != NUL) {
        do_intro_line(row, (char_u *)_(p), 0);
      }
      row++;
    }
  }

  // Make the wait-return message appear just below the text.
  if (colon) {
    msg_row = row;
  }
}

static void do_intro_line(int row, char_u *mesg, int attr)
{
  int col;
  char_u *p;
  int l;
  int clen;

  // Center the message horizontally.
  col = vim_strsize(mesg);

  col = (Columns - col) / 2;

  if (col < 0) {
    col = 0;
  }

  // Split up in parts to highlight <> items differently.
  for (p = mesg; *p != NUL; p += l) {
    clen = 0;

    for (l = 0; p[l] != NUL
         && (l == 0 || (p[l] != '<' && p[l - 1] != '>')); ++l) {
      if (has_mbyte) {
        clen += ptr2cells(p + l);
        l += (*mb_ptr2len)(p + l) - 1;
      } else {
        clen += byte2cells(p[l]);
      }
    }
    screen_puts_len(p, l, row, col, *p == '<' ? hl_attr(HLF_8) : attr);
    col += clen;
  }
}

/// ":intro": clear screen, display intro screen and wait for return.
///
/// @param eap
void ex_intro(exarg_T *eap)
{
  screenclear();
  intro_message(TRUE);
  wait_return(TRUE);
}