helpers.c File Reference

Shared code. More...

#include "config.h"
#include <ctype.h>
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "helpers.h"
#include "definition.h"
#include "mutt_thread.h"
#include "render.h"

Include dependency graph for helpers.c:

Go to the source code of this file.

Functions
const struct ExpandoRenderData *	find_get_number (const struct ExpandoRenderData *rdata, int did, int uid)
	Find a get_number() callback function.
const struct ExpandoRenderData *	find_get_string (const struct ExpandoRenderData *rdata, int did, int uid)
	Find a get_string() callback function.
const char *	skip_until_ch (const char *start, char terminator)
	Search a string for a terminator character.
static bool	is_valid_classic_expando (char ch)
	Is this a valid Expando character?
const char *	skip_until_classic_expando (const char *start)
	Search through string until we reach an Expando character.
const char *	skip_classic_expando (const char *str, const struct ExpandoDefinition *defs)
	Skip over the text of an Expando.
void	buf_lower_special (struct Buffer *buf)
	Convert to lowercase, excluding special characters.

Detailed Description

Shared code.

Authors

• Tóth János
• 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 helpers.c.

Function Documentation

find_get_number()

const struct ExpandoRenderData * find_get_number	(	const struct ExpandoRenderData *	rdata,
		int	did,
		int	uid
	)

Find a get_number() callback function.

Parameters

rdata	Render data to search
did	Domain ID to match
uid	Unique ID to match

Return values

ptr	Matching Render data

Definition at line 47 of file helpers.c.

{
  if (!rdata)
    return NULL;
 
  for (; rdata->did != -1; rdata++)
  {
    if ((rdata->did == did) && (rdata->uid == uid) && rdata->get_number)
    {
      return rdata;
    }
  }
 
  return NULL;
}

Here is the caller graph for this function:

find_get_string()

const struct ExpandoRenderData * find_get_string	(	const struct ExpandoRenderData *	rdata,
		int	did,
		int	uid
	)

Find a get_string() callback function.

Parameters

rdata	Render data to search
did	Domain ID to match
uid	Unique ID to match

Return values

ptr	Matching Render data

Definition at line 71 of file helpers.c.

{
  if (!rdata)
    return NULL;
 
  for (; rdata->did != -1; rdata++)
  {
    if ((rdata->did == did) && (rdata->uid == uid) && rdata->get_string)
    {
      return rdata;
    }
  }
 
  return NULL;
}

Here is the caller graph for this function:

skip_until_ch()

const char * skip_until_ch	(	const char *	start,
		char	terminator
	)

Search a string for a terminator character.

Parameters

start	Start of string
terminator	Character to find

Return values

ptr	Position of terminator character, or end-of-string

Definition at line 94 of file helpers.c.

{
  while (*start)
  {
    if (*start == terminator)
    {
      break;
    }
 
    start++;
  }
 
  return start;
}

Here is the caller graph for this function:

is_valid_classic_expando()

static bool is_valid_classic_expando ( char  ch )

static

Is this a valid Expando character?

Parameters

ch	Character to test

Return values

true	Valid Expando character

Definition at line 114 of file helpers.c.

{
  // NOTE(g0mb4): Maybe rework this?
  // if special expandos are added this list must be updated!
  return isalpha(ch) || (ch == ' ') || (ch == '!') || (ch == '(') ||
         (ch == '*') || (ch == '>') || (ch == '@') || (ch == '[') ||
         (ch == '^') || (ch == '{') || (ch == '|');
}

Here is the caller graph for this function:

skip_until_classic_expando()

const char * skip_until_classic_expando

(

const char *

start

)

Search through string until we reach an Expando character.

Parameters

start

Where to start looking

Return values

ptr	Match, or end-of-string

Definition at line 128 of file helpers.c.

{
  while (*start && !is_valid_classic_expando(*start))
  {
    start++;
  }
 
  return start;
}

Here is the call graph for this function:

Here is the caller graph for this function:

skip_classic_expando()

const char * skip_classic_expando	(	const char *	str,
		const struct ExpandoDefinition *	defs
	)

Skip over the text of an Expando.

Parameters

str	Starting place
defs	Expando definitions

Return values

ptr	Character after Expando, or end-of-string

Definition at line 144 of file helpers.c.

{
  ASSERT(str);
  if (*str == '\0')
    return str;
 
  const struct ExpandoDefinition *definitions = defs;
 
  while (definitions && definitions->short_name)
  {
    const bool is_two_char = mutt_str_len(definitions->short_name) == 2;
    const char *name = definitions->short_name;
 
    if (is_two_char && (name[0] == *str) && (name[1] == *(str + 1)))
    {
      str++;
      break;
    }
 
    definitions++;
  }
 
  str++;
  return str;
}

Here is the call graph for this function:

Here is the caller graph for this function:

buf_lower_special()

void buf_lower_special

(

struct Buffer *

buf

)

Convert to lowercase, excluding special characters.

Parameters

buf	String to lowercase

The string is transformed in place.

Definition at line 176 of file helpers.c.

{
  if (!buf || !buf->data)
    return;
 
  char *p = buf->data;
 
  while (*p)
  {
    if (*p == MUTT_SPECIAL_INDEX)
    {
      p += 2;
      continue;
    }
    else if (*p < MUTT_TREE_MAX)
    {
      p++;
      continue;
    }
 
    *p = tolower((unsigned char) *p);
    p++;
  }
}

Here is the caller graph for this function: