Simplify use of cache for ordinary applications
[libchamplain:potyl-perl.git] / champlain / champlain-file-cache.h
1 /*
2  * Copyright (C) 2009 Pierre-Luc Beaudoin <pierre-luc@pierlux.com>
3  * Copyright (C) 2010 Jiri Techet <techet@gmail.com>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18  */
19
20 #if !defined (__CHAMPLAIN_CHAMPLAIN_H_INSIDE__) && !defined (CHAMPLAIN_COMPILATION)
21 #error "Only <champlain/champlain.h> can be included directly."
22 #endif
23
24 #ifndef _CHAMPLAIN_FILE_CACHE_H_
25 #define _CHAMPLAIN_FILE_CACHE_H_
26
27 #include <glib-object.h>
28 #include <champlain/champlain-tile-cache.h>
29
30 G_BEGIN_DECLS
31
32 #define CHAMPLAIN_TYPE_FILE_CACHE             (champlain_file_cache_get_type ())
33 #define CHAMPLAIN_FILE_CACHE(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), CHAMPLAIN_TYPE_FILE_CACHE, ChamplainFileCache))
34 #define CHAMPLAIN_FILE_CACHE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), CHAMPLAIN_TYPE_FILE_CACHE, ChamplainFileCacheClass))
35 #define CHAMPLAIN_IS_FILE_CACHE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CHAMPLAIN_TYPE_FILE_CACHE))
36 #define CHAMPLAIN_IS_FILE_CACHE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), CHAMPLAIN_TYPE_FILE_CACHE))
37 #define CHAMPLAIN_FILE_CACHE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), CHAMPLAIN_TYPE_FILE_CACHE, ChamplainFileCacheClass))
38
39 typedef struct _ChamplainFileCache ChamplainFileCache;
40 typedef struct _ChamplainFileCacheClass ChamplainFileCacheClass;
41
42 struct _ChamplainFileCache
43 {
44   ChamplainTileCache parent_instance;
45 };
46
47 struct _ChamplainFileCacheClass
48 {
49   ChamplainTileCacheClass parent_class;
50 };
51
52 GType champlain_file_cache_get_type (void);
53
54 ChamplainFileCache* champlain_file_cache_new (void);
55 ChamplainFileCache* champlain_file_cache_new_full (guint size_limit,
56     const gchar *cache_dir, gboolean persistent);
57
58 guint champlain_file_cache_get_size_limit (ChamplainFileCache *file_cache);
59 void champlain_file_cache_set_size_limit (ChamplainFileCache *file_cache,
60     guint size_limit);
61
62 const gchar * champlain_file_cache_get_cache_dir (ChamplainFileCache *file_cache);
63
64 void champlain_file_cache_purge (ChamplainFileCache *file_cache);
65 void champlain_file_cache_purge_on_idle (ChamplainFileCache *file_cache);
66
67 G_END_DECLS
68
69 #endif /* _CHAMPLAIN_FILE_CACHE_H_ */