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
|
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* ibus - The Input IBus
* Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
* Copyright (C) 2008-2013 Red Hat, Inc.
*
* 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 Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif
#ifndef __IBUS_OBSERVED_PATH_H_
#define __IBUS_OBSERVED_PATH_H_
/**
* SECTION: ibusobservedpath
* @short_description: Path object of IBus.
* @stability: Stable
*
* IBusObservedPath provides methods for file path manipulation,
* such as monitor modification, directory tree traversal.
*/
#include "ibusserializable.h"
#include "ibusxml.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_OBSERVED_PATH \
(ibus_observed_path_get_type ())
#define IBUS_OBSERVED_PATH(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_OBSERVED_PATH, IBusObservedPath))
#define IBUS_OBSERVED_PATH_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_OBSERVED_PATH, IBusObservedPathClass))
#define IBUS_IS_OBSERVED_PATH(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_OBSERVED_PATH))
#define IBUS_IS_OBSERVED_PATH_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_OBSERVED_PATH))
#define IBUS_OBSERVED_PATH_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_OBSERVED_PATH, IBusObservedPathClass))
G_BEGIN_DECLS
typedef struct _IBusObservedPath IBusObservedPath;
typedef struct _IBusObservedPathClass IBusObservedPathClass;
/**
* IBusObservedPath:
* @path: Path to be handled.
* @mtime: Modified time.
* @is_dir: Whether the file is the path directory.
* @is_exist: Whether the file exists.
*
* Data structure of IBusObservedPath.
*/
struct _IBusObservedPath {
IBusSerializable parent;
/* instance members */
/*< public >*/
gchar *path;
glong mtime;
gboolean is_dir;
gboolean is_exist;
};
struct _IBusObservedPathClass {
IBusSerializableClass parent;
/* class members */
};
GType ibus_observed_path_get_type (void);
/**
* ibus_observed_path_new_from_xml_node:
* @node: An XML node that contain path.
* @fill_stat: Auto-fill the path status.
*
* Creates an new #IBusObservedPath from an XML node.
*
* Returns: A newly allocated #IBusObservedPath.
*/
IBusObservedPath *ibus_observed_path_new_from_xml_node (XMLNode *node,
gboolean fill_stat);
/**
* ibus_observed_path_new:
* @path: The path string.
* @fill_stat: Auto-fill the path status.
*
* Creates a new #IBusObservedPath from an XML node.
*
* Returns: A newly allocated #IBusObservedPath.
*/
IBusObservedPath *ibus_observed_path_new (const gchar *path,
gboolean fill_stat);
/**
* ibus_observed_path_traverse:
* @path: An IBusObservedPath.
* @dir_only: Only looks for subdirs, not files
*
* Recursively traverse the path and put the files and subdirectory in to
* a newly allocated
* GLists, if the @path is a directory. Otherwise returns NULL.
*
* Returns: (transfer full) (element-type IBusObservedPath): A newly allocate
* GList which holds content in path; NULL if @path is not directory.
*/
GList *ibus_observed_path_traverse (IBusObservedPath *path,
gboolean dir_only);
/**
* ibus_observed_path_check_modification:
* @path: An IBusObservedPath.
*
* Checks whether the path is modified by comparing the mtime in object and
* mtime in file system.
*
* Returns: %TRUE if imtime is changed, otherwise %FALSE.
*/
gboolean ibus_observed_path_check_modification (IBusObservedPath *path);
/**
* ibus_observed_path_output:
* @path: An IBusObservedPath.
* @output: Path is appended to.
* @indent: number of indent.
*
* Append the observed path to a string with following format:
* <path mtime="<i>modified time</i>" ><i>path</i></path>
*/
void ibus_observed_path_output (IBusObservedPath *path,
GString *output,
gint indent);
G_END_DECLS
#endif
|
