aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/file-utils.h
blob: 2b9003d5d74575e8bd960d611b6338d162f241a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
 * Copyright (C) 2012-2026 Robin Haberkorn
 *
 * 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 3 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/>.
 */
#pragma once

#include <string.h>

#include <glib.h>

#include "sciteco.h"
#include "string-utils.h"

typedef guint32 teco_file_attributes_t;
#define TECO_FILE_INVALID_ATTRIBUTES G_MAXUINT32

teco_file_attributes_t teco_file_get_attributes(const gchar *filename);
void teco_file_set_attributes(const gchar *filename, teco_file_attributes_t attrs);

/**
 * Get absolute/full version of a possibly relative path.
 * The path is tried to be canonicalized so it does
 * not contain relative components and symlinks.
 * Depending on platform and existence of the path,
 * canonicalization might fail, but the path returned is
 * always absolute.
 *
 * @param path Possibly relative path name.
 * @return Newly-allocated absolute path name.
 */
gchar *teco_file_get_absolute_path(const gchar *path);

/**
 * Normalize path or file name.
 *
 * This changes the directory separators
 * to forward slash (on platforms that support
 * different directory separator styles).
 *
 * @param path The path to normalize.
 *             It is changed in place.
 * @return Returns `path`. The return value
 *         may be ignored.
 */
static inline gchar *
teco_file_normalize_path(gchar *path)
{
#if G_DIR_SEPARATOR != '/'
	return g_strdelimit(path, G_DIR_SEPARATOR_S, '/');
#else
	return path;
#endif
}

gboolean teco_file_is_visible(const gchar *path);

static inline gboolean
teco_file_is_recovery(const gchar *path)
{
	g_autofree gchar *basename = g_path_get_basename(path);
	gsize len = strlen(basename);
	return len > 2 && basename[0] == '#' && basename[len-1] == '#';
}

static inline gchar *
teco_file_get_recovery(const gchar *path)
{
	g_autofree gchar *dirname = g_path_get_dirname(path);
	g_autofree gchar *basename = g_path_get_basename(path);
	return g_strconcat(dirname, G_DIR_SEPARATOR_S, "#", basename, "#", NULL);
}

/**
 * Get absolute path of the program executable.
 *
 * This may return the current working directory on
 * unsupported platforms.
 *
 * @return Newly-allocated path.
 */
gchar *teco_file_get_program_path(void);

gchar *teco_file_get_datadir(void);

gchar *teco_file_expand_path(const gchar *path);

/**
 * This gets the length of a file name's directory
 * component including any trailing directory separator.
 * It returns 0 if the file name does not have a directory
 * separator.
 * This is useful when constructing file names in the same
 * directory as an existing one, keeping the exact same
 * directory component (globbing, tab completion...).
 * Also if it returns non-0, this can be used to look up
 * the last used directory separator in the file name.
 */
static inline gsize
teco_file_get_dirname_len(const gchar *path)
{
	gsize len = 0;

	for (const gchar *p = path; *p; p++)
		if (G_IS_DIR_SEPARATOR(*p))
			len = p - path + 1;

	return len;
}

static inline gboolean
teco_file_is_dir(const gchar *filename)
{
	if (!*filename)
		return FALSE;

	gchar c = filename[strlen(filename)-1];
	return G_IS_DIR_SEPARATOR(c);
}

gboolean teco_file_auto_complete(const gchar *filename, GFileTest file_test, teco_string_t *insert);