mbtable.c File Reference

Type representing a multibyte character table. More...

#include "config.h"
#include <stdint.h>
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "mbtable.h"
#include "set.h"
#include "types.h"

Include dependency graph for mbtable.c:

Go to the source code of this file.

Functions
bool	mbtable_equal (const struct MbTable *a, const struct MbTable *b)
	Compare two MbTables.
struct MbTable *	mbtable_parse (const char *s)
	Parse a multibyte string into a table.
static void	mbtable_destroy (void *var, const struct ConfigDef *cdef)
	Destroy an MbTable object - Implements ConfigSetType::destroy() -.
static int	mbtable_string_set (void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Set an MbTable by string - Implements ConfigSetType::string_set() -.
static int	mbtable_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a MbTable as a string - Implements ConfigSetType::string_get() -.
static struct MbTable *	mbtable_dup (struct MbTable *table)
	Create a copy of an MbTable object.
static int	mbtable_native_set (void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Set an MbTable config item by MbTable object - Implements ConfigSetType::native_set() -.
static intptr_t	mbtable_native_get (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Get an MbTable object from a MbTable config item - Implements ConfigSetType::native_get() -.
static bool	mbtable_has_been_set (void *var, const struct ConfigDef *cdef)
	Is the config value different to its initial value?
static int	mbtable_reset (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Reset an MbTable to its initial value - Implements ConfigSetType::reset() -.
void	mbtable_free (struct MbTable **ptr)
	Free an MbTable object.
const char *	mbtable_get_nth_wchar (const struct MbTable *table, int index)
	Extract one char from a multi-byte table.

Variables
const struct ConfigSetType	CstMbtable
	Config type representing a multi-byte table.

Detailed Description

Type representing a multibyte character table.

Authors

• Richard Russon
• Pietro Cerutti

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

Function Documentation

mbtable_equal()

bool mbtable_equal	(	const struct MbTable *	a,
		const struct MbTable *	b )

Compare two MbTables.

Parameters

a	First MbTable
b	Second MbTable

Return values

true	They are identical

Definition at line 51 of file mbtable.c.

{
  if (!a && !b) /* both empty */
    return true;
  if (!a ^ !b) /* one is empty, but not the other */
    return false;
 
  return mutt_str_equal(a->orig_str, b->orig_str);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mbtable_parse()

struct MbTable * mbtable_parse

(

const char *

s

)

Parse a multibyte string into a table.

Parameters

s	String of multibyte characters

Return values

ptr	New MbTable object

Definition at line 66 of file mbtable.c.

{
  struct MbTable *t = NULL;
  size_t slen, k;
  mbstate_t mbstate = { 0 };
  char *d = NULL;
 
  slen = mutt_str_len(s);
  if (!slen)
    return NULL;
 
  t = MUTT_MEM_CALLOC(1, struct MbTable);
 
  t->orig_str = mutt_str_dup(s);
  /* This could be more space efficient.  However, being used on tiny
   * strings (`$to_chars` and `$status_chars`), the overhead is not great. */
  t->chars = MUTT_MEM_CALLOC(slen, char *);
  t->segmented_str = MUTT_MEM_CALLOC(slen * 2, char);
  d = t->segmented_str;
 
  while (slen && (k = mbrtowc(NULL, s, slen, &mbstate)))
  {
    if ((k == ICONV_ILLEGAL_SEQ) || (k == ICONV_BUF_TOO_SMALL))
    {
      /* XXX put message in err buffer; fail? warning? */
      mutt_debug(LL_DEBUG1, "mbrtowc returned %zd converting %s in %s\n", k, s, t->orig_str);
      if (k == ICONV_ILLEGAL_SEQ)
        memset(&mbstate, 0, sizeof(mbstate));
      k = (k == ICONV_ILLEGAL_SEQ) ? 1 : slen;
    }
 
    slen -= k;
    t->chars[t->len++] = d;
    while (k-- > 0)
      *d++ = *s++;
    *d++ = '\0';
  }
 
  return t;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mbtable_dup()

static struct MbTable * mbtable_dup ( struct MbTable * table )

static

Create a copy of an MbTable object.

Parameters

table

MbTable to duplicate

Return values

ptr	New MbTable object

Definition at line 202 of file mbtable.c.

{
  if (!table)
    return NULL; /* LCOV_EXCL_LINE */
 
  struct MbTable *m = MUTT_MEM_CALLOC(1, struct MbTable);
  m->orig_str = mutt_str_dup(table->orig_str);
  return m;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mbtable_free()

void mbtable_free

(

struct MbTable **

ptr

)

Free an MbTable object.

Parameters

[out]

ptr

MbTable to free

Definition at line 317 of file mbtable.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct MbTable *table = *ptr;
  FREE(&table->orig_str);
  FREE(&table->chars);
  FREE(&table->segmented_str);
 
  FREE(ptr);
}

Here is the caller graph for this function:

mbtable_get_nth_wchar()

const char * mbtable_get_nth_wchar	(	const struct MbTable *	table,
		int	index )

Extract one char from a multi-byte table.

Parameters

table	Multi-byte table
index	Select this character

Return values

ptr	String pointer to the character

Extract one multi-byte character from a string table. If the index is invalid, then a space character will be returned. If the character selected is '
' (Ctrl-M), then "" will be returned.

Definition at line 340 of file mbtable.c.

{
  if (!table || !table->chars || (index < 0) || (index >= table->len))
    return " ";
 
  if (table->chars[index][0] == '\r')
    return "";
 
  return table->chars[index];
}

Here is the caller graph for this function:

Variable Documentation

CstMbtable

const struct ConfigSetType CstMbtable

Initial value:

= {
  DT_MBTABLE,
  "mbtable",
  mbtable_string_set,
  mbtable_string_get,
  mbtable_native_set,
  mbtable_native_get,
  NULL, 
  NULL, 
  mbtable_has_been_set,
  mbtable_reset,
  mbtable_destroy,
}

Config type representing a multi-byte table.

Definition at line 354 of file mbtable.c.

                                        {
  DT_MBTABLE,
  "mbtable",
  mbtable_string_set,
  mbtable_string_get,
  mbtable_native_set,
  mbtable_native_get,
  NULL, // string_plus_equals
  NULL, // string_minus_equals
  mbtable_has_been_set,
  mbtable_reset,
  mbtable_destroy,
};