extended.c File Reference

Set up the extended keys. More...

#include "config.h"
#include <stdbool.h>
#include <strings.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "extended.h"
#include "module_data.h"

Include dependency graph for extended.c:

Go to the source code of this file.

Data Structures
struct	Extkey
	Map key names from NeoMutt's style to Curses style. More...

Functions
const char *	ext_key_find (const char *key)
	Find the curses name for a key.
void	ext_keys_init (struct Mapping *key_names)
	Initialise map of ncurses extended keys.

Variables
static const struct Extkey	ExtKeys []
	Mapping between NeoMutt and Curses key names.

Detailed Description

Set up the extended keys.

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 extended.c.

Function Documentation

ext_key_find()

const char * ext_key_find

(

const char *

key

)

Find the curses name for a key.

Parameters

key

Key name

Return values

ptr	Curses name

Look up NeoMutt's name for a key and find the ncurses extended name for it.

Note

This returns a static string.

Definition at line 95 of file extended.c.

{
  for (int i = 0; ExtKeys[i].name; i++)
  {
    if (strcasecmp(key, ExtKeys[i].name) == 0)
      return ExtKeys[i].sym;
  }
  return 0;
}

Here is the caller graph for this function:

ext_keys_init()

void ext_keys_init

(

struct Mapping *

key_names

)

Initialise map of ncurses extended keys.

Parameters

key_names

Array of key name/value mappings to populate

Determine the keycodes for ncurses extended keys and fill in the KeyNames array.

This function must be called after initscr(), or mutt_tigetstr() fails. This creates a bit of a chicken-and-egg problem because km_init() is called prior to start_curses(). This means that the default keybindings can't include any of the extended keys because they won't be defined until later.

Definition at line 116 of file extended.c.

{
  use_extended_names(true);
 
  for (int i = 0; key_names[i].name; i++)
  {
    if (key_names[i].value == -1)
    {
      const char *keyname = ext_key_find(key_names[i].name);
 
      if (keyname)
      {
        const char *s = mutt_tigetstr((char *) keyname);
        if (s && ((long) (s) != -1))
        {
          int code = key_defined(s);
          if (code > 0)
            key_names[i].value = code;
        }
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ExtKeys

const struct Extkey ExtKeys[]

static

Mapping between NeoMutt and Curses key names.

Definition at line 50 of file extended.c.

                                       {
  { "<c-up>", "kUP5" },
  { "<s-up>", "kUP" },
  { "<a-up>", "kUP3" },
 
  { "<s-down>", "kDN" },
  { "<a-down>", "kDN3" },
  { "<c-down>", "kDN5" },
 
  { "<c-right>", "kRIT5" },
  { "<s-right>", "kRIT" },
  { "<a-right>", "kRIT3" },
 
  { "<s-left>", "kLFT" },
  { "<a-left>", "kLFT3" },
  { "<c-left>", "kLFT5" },
 
  { "<s-home>", "kHOM" },
  { "<a-home>", "kHOM3" },
  { "<c-home>", "kHOM5" },
 
  { "<s-end>", "kEND" },
  { "<a-end>", "kEND3" },
  { "<c-end>", "kEND5" },
 
  { "<s-next>", "kNXT" },
  { "<a-next>", "kNXT3" },
  { "<c-next>", "kNXT5" },
 
  { "<s-prev>", "kPRV" },
  { "<a-prev>", "kPRV3" },
  { "<c-prev>", "kPRV5" },
 
  { 0, 0 },
};