Type representing a path. More...

#include "config.h"
#include <stddef.h>
#include <limits.h>
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "set.h"
#include "types.h"

Include dependency graph for path.c:

Go to the source code of this file.

Functions
static char *	path_tidy (const char *path, bool is_dir)
	Tidy a path for storage. More...

static void	path_destroy (const struct ConfigSet cs, void var, const struct ConfigDef *cdef)
	Destroy a Path - Implements ConfigSetType::destroy() -. More...

static int	path_string_set (const struct ConfigSet cs, void var, struct ConfigDef cdef, const char value, struct Buffer *err)
	Set a Path by string - Implements ConfigSetType::string_set() -. More...

static int	path_string_get (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer result)
	Get a Path as a string - Implements ConfigSetType::string_get() -. More...

static int	path_native_set (const struct ConfigSet cs, void var, const struct ConfigDef cdef, intptr_t value, struct Buffer err)
	Set a Path config item by string - Implements ConfigSetType::native_set() -. More...

static intptr_t	path_native_get (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Get a string from a Path config item - Implements ConfigSetType::native_get() -. More...

static int	path_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Path to its initial value - Implements ConfigSetType::reset() -. More...

Variables
char *	HomeDir
	User's home directory. More...

const struct ConfigSetType	CstPath
	Config type representing a path. More...

Detailed Description

Type representing a path.

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

Function Documentation

◆ path_tidy()

static char * path_tidy	(	const char *	path,
		bool	is_dir
	)

static

Tidy a path for storage.

Parameters

path	Path to be tidied
is_dir	Is the path a directory?

Return values

ptr Tidy path

Expand ~ and remove junk like /./

Note: The caller must free the returned string

Definition at line 56 of file path.c.

{
  if (!path || (*path == '\0'))
    return NULL;
 
  char buf[PATH_MAX] = { 0 };
  mutt_str_copy(buf, path, sizeof(buf));
 
  mutt_path_tilde(buf, sizeof(buf), HomeDir);
  mutt_path_tidy(buf, is_dir);
 
  return mutt_str_dup(buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ HomeDir

char* HomeDir

extern

User's home directory.

Definition at line 38 of file globals.c.

◆ CstPath

const struct ConfigSetType CstPath

Initial value:

= {
  DT_PATH,
  "path",
  path_string_set,
  path_string_get,
  path_native_set,
  path_native_get,
  NULL, 
  NULL, 
  path_reset,
  path_destroy,
}

Config type representing a path.

Definition at line 247 of file path.c.