File: foundry-path-cache.c

package info (click to toggle)
foundry 1.1~beta-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,552 kB
  • sloc: ansic: 167,487; xml: 417; makefile: 21; sh: 19; javascript: 10
file content (185 lines) | stat: -rw-r--r-- 5,314 bytes parent folder | download | duplicates (2)
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/* foundry-path-cache.c
 *
 * Copyright 2022-2024 Christian Hergert <chergert@redhat.com>
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * This library 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
 * Lesser 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/>.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#include "config.h"

#include "foundry-path-cache.h"

/**
 * FoundryPathCache:
 *
 * Thread-safe cache for path lookups
 *
 * #FoundryPathCache can be used to cache path lookup entries as often
 * needed by runtimes.
 *
 * This object is thread-safe and may be accessed from multiple
 * threads simultaneously.
 */

struct _FoundryPathCache
{
  GObject     parent_instance;
  GMutex      mutex;
  GHashTable *cache;
};

G_DEFINE_FINAL_TYPE (FoundryPathCache, foundry_path_cache, G_TYPE_OBJECT)

static void
foundry_path_cache_dispose (GObject *object)
{
  FoundryPathCache *self = (FoundryPathCache *)object;

  g_mutex_lock (&self->mutex);
  g_hash_table_remove_all (self->cache);
  g_mutex_unlock (&self->mutex);

  G_OBJECT_CLASS (foundry_path_cache_parent_class)->dispose (object);
}

static void
foundry_path_cache_finalize (GObject *object)
{
  FoundryPathCache *self = (FoundryPathCache *)object;

  g_clear_pointer (&self->cache, g_hash_table_unref);
  g_mutex_clear (&self->mutex);

  G_OBJECT_CLASS (foundry_path_cache_parent_class)->finalize (object);
}

static void
foundry_path_cache_class_init (FoundryPathCacheClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->dispose = foundry_path_cache_dispose;
  object_class->finalize = foundry_path_cache_finalize;
}

static void
foundry_path_cache_init (FoundryPathCache *self)
{
  g_mutex_init (&self->mutex);
  self->cache = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
}

FoundryPathCache *
foundry_path_cache_new (void)
{
  return g_object_new (FOUNDRY_TYPE_PATH_CACHE, NULL);
}

/**
 * foundry_path_cache_lookup:
 * @self: a #FoundryPathCache
 * @program_name: the program name to lookup
 * @program_path: (out) (transfer full) (nullable): a location to store
 *   the @program_path for @program_name.
 *
 * %TRUE is returned when an entry is found in the cache. That entry
 * may be %NULL indicating a negative cache entry.
 *
 * Returns: %TRUE if @program_name was found and @program_path is set;
 *   otherwise %FALSE is returned.
 */
gboolean
foundry_path_cache_lookup (FoundryPathCache  *self,
                           const char        *program_name,
                           char             **program_path)
{
  const char *path = NULL;
  gboolean ret;

  g_return_val_if_fail (FOUNDRY_IS_PATH_CACHE (self), FALSE);
  g_return_val_if_fail (program_name, FALSE);

  g_mutex_lock (&self->mutex);
  ret = g_hash_table_lookup_extended (self->cache, program_name, NULL, (gpointer *)&path);
  if (program_path != NULL)
    *program_path = path ? g_strdup (path) : NULL;
  g_mutex_unlock (&self->mutex);

  return ret;
}

/**
 * foundry_path_cache_contains:
 * @self: a #FoundryPathCache
 * @program_name: the name of the program to lookup
 * @had_program_path: (out) (nullable): a location to store if a path
 *   was found for @program_name.
 *
 * This function helps for detecting negative cache entries without
 * copying the program_path string.
 *
 * Returns: %TRUE if an entry was found and @had_program_path is set;
 *   otherwise %FALSE.
 */
gboolean
foundry_path_cache_contains (FoundryPathCache *self,
                             const char       *program_name,
                             gboolean         *had_program_path)
{
  const char *path = NULL;
  gboolean ret;

  g_return_val_if_fail (FOUNDRY_IS_PATH_CACHE (self), FALSE);
  g_return_val_if_fail (program_name, FALSE);

  g_mutex_lock (&self->mutex);
  ret = g_hash_table_lookup_extended (self->cache, program_name, NULL, (gpointer *)&path);
  if (had_program_path)
    *had_program_path = path != NULL;
  g_mutex_unlock (&self->mutex);

  return ret;
}

/**
 * foundry_path_cache_insert:
 * @self: a #FoundryPathCache
 * @program_name: the name of the program
 * @program_path: (nullable): the path for the program
 *
 * Inserts a cache entry for @program_name for @program_path.
 *
 * @program_path may be %NULL to register a negative cache entry. See
 * foundry_path_cache_lookup() for handling negative cache entries.
 */
void
foundry_path_cache_insert (FoundryPathCache *self,
                           const char       *program_name,
                           const char       *program_path)
{
  char *key;
  char *value;

  g_return_if_fail (FOUNDRY_IS_PATH_CACHE (self));
  g_return_if_fail (program_name != NULL);

  key = g_strdup (program_name);
  value = g_strdup (program_path);

  g_mutex_lock (&self->mutex);
  g_hash_table_insert (self->cache, key, value);
  g_mutex_unlock (&self->mutex);
}