1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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 of the License, or (at your option) any later version.
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.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
27 #include "gfileattribute.h"
28 #include "gfileattribute-priv.h"
29 #include <glib-object.h>
35 * SECTION:gfileattribute
36 * @short_description: Key-Value Paired File Attributes
38 * @see_also: #GFile, #GFileInfo
40 * File attributes in GIO consist of a list of key-value pairs.
42 * Keys are strings that contain a key namespace and a key name, separated
43 * by a colon, e.g. "namespace:keyname". Namespaces are included to sort
44 * key-value pairs by namespaces for relevance. Keys can be retrived
45 * using wildcards, e.g. "standard::*" will return all of the keys in the
46 * "standard" namespace.
48 * Values are stored within the list in #GFileAttributeValue structures.
49 * Values can store different types, listed in the enum #GFileAttributeType.
50 * Upon creation of a #GFileAttributeValue, the type will be set to
51 * %G_FILE_ATTRIBUTE_TYPE_INVALID.
53 * The list of possible attributes for a filesystem (pointed to by a #GFile) is
54 * availible as a #GFileAttributeInfoList. This list is queryable by key names
55 * as indicated earlier.
57 * Classes that implement #GFileIface will create a #GFileAttributeInfoList and
58 * install default keys and values for their given file system, architecture,
59 * and other possible implementation details (e.g., on a UNIX system, a file
60 * attribute key will be registered for the user id for a given file).
64 * <title>GFileAttributes Default Namespaces</title>
65 * <tgroup cols='2' align='left'><thead>
66 * <row><entry>Namspace</entry><entry>Description</entry></row>
69 * <row><entry>"standard"</entry><entry>The "Standard" namespace. General file
70 * information that any application may need should be put in this namespace.
71 * Examples include the file's name, type, and size.</entry></row>
72 * <row><entry>"etag"</entry><entry>The <link linkend="gfile-etag">"Entity Tag"</link>
73 * namespace. Currently, the only key in this namespace is "value", which contains
74 * the value of the current entity tag.</entry></row>
75 * <row><entry>"id"</entry><entry>The "Identification" namespace. This
76 * namespace is used by file managers and applications that list directories
77 * to check for loops and to uniquely identify files.</entry></row>
78 * <row><entry>"access"</entry><entry>The "Access" namespace. Used to check
79 * if a user has the proper privilidges to access files and perform
80 * file operations. Keys in this namespace are made to be generic
81 * and easily understood, e.g. the "can_read" key is %TRUE if
82 * the current user has permission to read the file. UNIX permissions and
83 * NTFS ACLs in Windows should be mapped to these values.</entry></row>
84 * <row><entry>"mountable"</entry><entry>The "Mountable" namespace. Includes
85 * simple boolean keys for checking if a file or path supports mount operations, e.g.
86 * mount, unmount, eject. These are used for files of type %G_FILE_TYPE_MOUNTABLE.</entry></row>
87 * <row><entry>"time"</entry><entry>The "Time" namespace. Includes file
88 * access, changed, created times. </entry></row>
89 * <row><entry>"unix"</entry><entry>The "Unix" namespace. Includes UNIX-specific
90 * information and may not be available for all files. Examples include
91 * the UNIX "UID", "GID", etc.</entry></row>
92 * <row><entry>"dos"</entry><entry>The "DOS" namespace. Includes DOS-specific
93 * information and may not be available for all files. Examples include
94 * "is_system" for checking if a file is marked as a system file, and "is_archive"
95 * for checking if a file is marked as an archive file.</entry></row>
96 * <row><entry>"owner"</entry><entry>The "Owner" namespace. Includes information
97 * about who owns a file. May not be available for all file systems. Examples include
98 * "user" for getting the user name of the file owner. This information is often mapped from
99 * some backend specific data such as a unix UID.</entry></row>
100 * <row><entry>"thumbnail"</entry><entry>The "Thumbnail" namespace. Includes
101 * information about file thumbnails and their location within the file system. Exaples of
102 * keys in this namespace include "path" to get the location of a thumbnail, and "failed"
103 * to check if thumbnailing of the file failed.</entry></row>
104 * <row><entry>"filesystem"</entry><entry>The "Filesystem" namespace. Gets information
105 * about the file system where a file is located, such as its type, how much
106 * space is left available, and the overall size of the file system.</entry></row>
107 * <row><entry>"gvfs"</entry><entry>The "GVFS" namespace. Keys in this namespace
108 * contain information about the current GVFS backend in use. </entry></row>
109 * <row><entry>"xattr"</entry><entry>The "xattr" namespace. Gets information
110 * about extended user attributes. See attr(5). The "user." prefix of the
111 * extended user attribute name is stripped away when constructing keys in
112 * this namespace, e.g. "xattr::mime_type" for the extended attribute with
113 * the name "user.mime_type". Note that this information is only available
114 * if GLib has been built with extended attribute support.</entry></row>
115 * <row><entry>"xattr-sys"</entry><entry>The "xattr-sys" namespace.
116 * Gets information about extended attributes which are not user-specific.
117 * See attr(5). Note that this information is only available if GLib
118 * has been built with extended attribute support.</entry></row>
119 * <row><entry>"selinux"</entry><entry>The "SELinux" namespace. Includes
120 * information about the SELinux context of files. Note that this information
121 * is only available if GLib has been built with SELinux support.</entry></row>
127 * Please note that these are not all of the possible namespaces.
128 * More namespaces can be added from GIO modules or by individual applications.
129 * For more information about writing GIO modules, see #GIOModule.
131 * <!-- TODO: Implementation note about using extended attributes on supported
135 * <title>GFileAttributes Built-in Keys and Value Types</title>
136 * <tgroup cols='3' align='left'><thead>
137 * <row><entry>Enum Value</entry><entry>Namespace:Key</entry><entry>Value Type</entry></row>
139 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TYPE</entry><entry>standard::type</entry><entry>uint32 (#GFileType)</entry></row>
140 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN</entry><entry>standard::is-hidden</entry><entry>boolean</entry></row>
141 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP</entry><entry>standard::is-backup</entry><entry>boolean</entry></row>
142 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK</entry><entry>standard::is-symlink</entry><entry>boolean</entry></row>
143 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL</entry><entry>standard::is-virtual</entry><entry>boolean</entry></row>
144 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_NAME</entry><entry>standard::name</entry><entry>byte string</entry></row>
145 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME</entry><entry>standard::display-name</entry><entry>string</entry></row>
146 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME</entry><entry>standard::edit-name</entry><entry>string</entry></row>
147 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_ICON</entry><entry>standard::icon</entry><entry>object (#GIcon)</entry></row>
148 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE</entry><entry>standard::content-type</entry><entry>string</entry></row>
149 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE</entry><entry>standard::fast-content-type</entry><entry>string</entry></row>
150 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SIZE</entry><entry>standard::size</entry><entry>uint64</entry></row>
151 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET</entry><entry>standard::symlink-target</entry><entry>byte string</entry></row>
152 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TARGET_URI</entry><entry>standard::target-uri</entry><entry>string</entry></row>
153 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER</entry><entry>standard::sort-order</entry><entry>int32</entry></row>
154 * <row><entry>%G_FILE_ATTRIBUTE_ETAG_VALUE</entry><entry>etag::value</entry><entry>string</entry></row>
155 * <row><entry>%G_FILE_ATTRIBUTE_ID_FILE</entry><entry>id::file</entry><entry>string</entry></row>
156 * <row><entry>%G_FILE_ATTRIBUTE_ID_FILESYSTEM</entry><entry>id::filesystem</entry><entry>string</entry></row>
157 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_READ</entry><entry>access::can-read</entry><entry>boolean</entry></row>
158 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE</entry><entry>access::can-write</entry><entry>boolean</entry></row>
159 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE</entry><entry>access::can-execute</entry><entry>boolean</entry></row>
160 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE</entry><entry>access::can-delete</entry><entry>boolean</entry></row>
161 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH</entry><entry>access::can-trash</entry><entry>boolean</entry></row>
162 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME</entry><entry>access::can-rename</entry><entry>boolean</entry></row>
163 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT</entry><entry>mountable::can-mount</entry><entry>boolean</entry></row>
164 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT</entry><entry>mountable::can-unmount</entry><entry>boolean</entry></row>
165 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT</entry><entry>mountable::can-eject</entry><entry>boolean</entry></row>
166 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE</entry><entry>mountable::unix-device</entry><entry>uint32</entry></row>
167 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI</entry><entry>mountable::hal-udi</entry><entry>string</entry></row>
168 * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED</entry><entry>time::modified</entry><entry>uint64</entry></row>
169 * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC</entry><entry>time::modified-usec</entry><entry>uint32</entry></row>
170 * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS</entry><entry>time::access</entry><entry>uint64</entry></row>
171 * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS_USEC</entry><entry>time::access-usec</entry><entry>uint32</entry></row>
172 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED</entry><entry>time::changed</entry><entry>uint64</entry></row>
173 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED_USEC</entry><entry>time::changed-usec</entry><entry>uint32</entry></row>
174 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED</entry><entry>time::created</entry><entry>uint64</entry></row>
175 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED_USEC</entry><entry>time::created-usec</entry><entry>uint32</entry></row>
176 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_DEVICE</entry><entry>unix::device</entry><entry>uint32</entry></row>
177 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_INODE</entry><entry>unix::inode</entry><entry>uint64</entry></row>
178 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_MODE</entry><entry>unix::mode</entry><entry>uint32</entry></row>
179 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_NLINK</entry><entry>unix::nlink</entry><entry>uint32</entry></row>
180 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_UID</entry><entry>unix::uid</entry><entry>uint32</entry></row>
181 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_GID</entry><entry>unix::gid</entry><entry>uint32</entry></row>
182 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_RDEV</entry><entry>unix::rdev</entry><entry>uint32</entry></row>
183 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE</entry><entry>unix::block-size</entry><entry>uint32</entry></row>
184 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCKS</entry><entry>unix::blocks</entry><entry>uint64</entry></row>
185 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT</entry><entry>unix::is-mountpoint</entry><entry>boolean</entry></row>
186 * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE</entry><entry>dos::is-archive</entry><entry>boolean</entry></row>
187 * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_SYSTEM</entry><entry>dos::is-system</entry><entry>boolean</entry></row>
188 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER</entry><entry>owner::user</entry><entry>string</entry></row>
189 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER_REAL</entry><entry>owner::user-real</entry><entry>string</entry></row>
190 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_GROUP</entry><entry>owner::group</entry><entry>string</entry></row>
191 * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAIL_PATH</entry><entry>thumbnail::path</entry><entry>bytestring</entry></row>
192 * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAILING_FAILED</entry><entry>thumbnail::failed</entry><entry>boolean</entry></row>
193 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE</entry><entry>filesystem::size</entry><entry>uint64</entry></row>
194 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_FREE</entry><entry>filesystem::free</entry><entry>uint64</entry></row>
195 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_TYPE</entry><entry>filesystem::type</entry><entry>string</entry></row>
196 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_READONLY</entry><entry>filesystem::readonly</entry><entry>boolean</entry></row>
197 * <row><entry>%G_FILE_ATTRIBUTE_GVFS_BACKEND</entry><entry>gvfs::backend</entry><entry>string</entry></row>
198 * <row><entry>%G_FILE_ATTRIBUTE_SELINUX_CONTEXT</entry><entry>selinux::context</entry><entry>string</entry></row>
199 * </tbody></tgroup></table></para>
201 * Note that there are no predefined keys in the "xattr" and "xattr-sys"
202 * namespaces. Keys for the "xattr" namespace are constructed by stripping
203 * away the "user." prefix from the extended user attribute, and prepending
204 * "xattr::". Keys for the "xattr-sys" namespace are constructed by
205 * concatenating "xattr-sys::" with the extended attribute name. All extended
206 * attribute values are returned as hex-encoded strings in which bytes outside
207 * the ASCII range are encoded as hexadecimal escape sequences of the form
208 * \x<replaceable>nn</replaceable>.
212 * _g_file_attribute_value_free:
213 * @attr: a #GFileAttributeValue.
215 * Frees the memory used by @attr.
219 _g_file_attribute_value_free (GFileAttributeValue
*attr
)
221 g_return_if_fail (attr
!= NULL
);
223 _g_file_attribute_value_clear (attr
);
228 * _g_file_attribute_value_clear:
229 * @attr: a #GFileAttributeValue.
231 * Clears the value of @attr and sets its type to
232 * %G_FILE_ATTRIBUTE_TYPE_INVALID.
236 _g_file_attribute_value_clear (GFileAttributeValue
*attr
)
238 g_return_if_fail (attr
!= NULL
);
240 if (attr
->type
== G_FILE_ATTRIBUTE_TYPE_STRING
||
241 attr
->type
== G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
)
242 g_free (attr
->u
.string
);
244 if (attr
->type
== G_FILE_ATTRIBUTE_TYPE_OBJECT
&&
246 g_object_unref (attr
->u
.obj
);
248 attr
->type
= G_FILE_ATTRIBUTE_TYPE_INVALID
;
252 * g_file_attribute_value_set:
253 * @attr: a #GFileAttributeValue to set the value in.
254 * @new_value: a #GFileAttributeValue to get the value from.
256 * Sets an attribute's value from another attribute.
259 _g_file_attribute_value_set (GFileAttributeValue
*attr
,
260 const GFileAttributeValue
*new_value
)
262 g_return_if_fail (attr
!= NULL
);
263 g_return_if_fail (new_value
!= NULL
);
265 _g_file_attribute_value_clear (attr
);
268 if (attr
->type
== G_FILE_ATTRIBUTE_TYPE_STRING
||
269 attr
->type
== G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
)
270 attr
->u
.string
= g_strdup (attr
->u
.string
);
272 if (attr
->type
== G_FILE_ATTRIBUTE_TYPE_OBJECT
&&
274 g_object_ref (attr
->u
.obj
);
278 * _g_file_attribute_value_new:
280 * Creates a new file attribute.
282 * Returns: a #GFileAttributeValue.
284 GFileAttributeValue
*
285 _g_file_attribute_value_new (void)
287 GFileAttributeValue
*attr
;
289 attr
= g_new (GFileAttributeValue
, 1);
290 attr
->type
= G_FILE_ATTRIBUTE_TYPE_INVALID
;
295 _g_file_attribute_value_peek_as_pointer (GFileAttributeValue
*attr
)
297 switch (attr
->type
) {
298 case G_FILE_ATTRIBUTE_TYPE_STRING
:
299 case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
:
300 return attr
->u
.string
;
301 case G_FILE_ATTRIBUTE_TYPE_OBJECT
:
304 return (gpointer
) &attr
->u
;
309 * g_file_attribute_value_dup:
310 * @other: a #GFileAttributeValue to duplicate.
312 * Duplicates a file attribute.
314 * Returns: a duplicate of the @other.
316 GFileAttributeValue
*
317 _g_file_attribute_value_dup (const GFileAttributeValue
*other
)
319 GFileAttributeValue
*attr
;
321 g_return_val_if_fail (other
!= NULL
, NULL
);
323 attr
= g_new (GFileAttributeValue
, 1);
324 attr
->type
= G_FILE_ATTRIBUTE_TYPE_INVALID
;
325 _g_file_attribute_value_set (attr
, other
);
332 return c
>= 32 && c
<= 126 && c
!= '\\';
336 escape_byte_string (const char *str
)
340 char *escaped_val
, *p
;
342 char *hex_digits
= "0123456789abcdef";
347 for (i
= 0; i
< len
; i
++)
349 if (!valid_char (str
[i
]))
353 if (num_invalid
== 0)
354 return g_strdup (str
);
357 escaped_val
= g_malloc (len
+ num_invalid
*3 + 1);
360 for (i
= 0; i
< len
; i
++)
369 *p
++ = hex_digits
[(c
>> 8) & 0xf];
370 *p
++ = hex_digits
[c
& 0xf];
379 * g_file_attribute_value_as_string:
380 * @attr: a #GFileAttributeValue.
382 * Converts a #GFileAttributeValue to a string for display.
383 * The returned string should be freed when no longer needed.
385 * Returns: a string from the @attr, %NULL on error, or "<invalid>"
386 * if @attr is of type %G_FILE_ATTRIBUTE_TYPE_INVALID.
389 _g_file_attribute_value_as_string (const GFileAttributeValue
*attr
)
393 g_return_val_if_fail (attr
!= NULL
, NULL
);
397 case G_FILE_ATTRIBUTE_TYPE_STRING
:
398 str
= g_strdup (attr
->u
.string
);
400 case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
:
401 str
= escape_byte_string (attr
->u
.string
);
403 case G_FILE_ATTRIBUTE_TYPE_BOOLEAN
:
404 str
= g_strdup_printf ("%s", attr
->u
.boolean
?"TRUE":"FALSE");
406 case G_FILE_ATTRIBUTE_TYPE_UINT32
:
407 str
= g_strdup_printf ("%u", (unsigned int)attr
->u
.uint32
);
409 case G_FILE_ATTRIBUTE_TYPE_INT32
:
410 str
= g_strdup_printf ("%i", (int)attr
->u
.int32
);
412 case G_FILE_ATTRIBUTE_TYPE_UINT64
:
413 str
= g_strdup_printf ("%"G_GUINT64_FORMAT
, attr
->u
.uint64
);
415 case G_FILE_ATTRIBUTE_TYPE_INT64
:
416 str
= g_strdup_printf ("%"G_GINT64_FORMAT
, attr
->u
.int64
);
418 case G_FILE_ATTRIBUTE_TYPE_OBJECT
:
419 str
= g_strdup_printf ("%s:%p", g_type_name_from_instance
420 ((GTypeInstance
*) attr
->u
.obj
),
424 g_warning ("Invalid type in GFileInfo attribute");
425 str
= g_strdup ("<invalid>");
433 * g_file_attribute_value_get_string:
434 * @attr: a #GFileAttributeValue.
436 * Gets the string from a file attribute value. If the value is not the
437 * right type then %NULL will be returned.
439 * Returns: the string value contained within the attribute, or %NULL.
442 _g_file_attribute_value_get_string (const GFileAttributeValue
*attr
)
447 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_STRING
, NULL
);
449 return attr
->u
.string
;
453 * g_file_attribute_value_get_byte_string:
454 * @attr: a #GFileAttributeValue.
456 * Gets the byte string from a file attribute value. If the value is not the
457 * right type then %NULL will be returned.
459 * Returns: the byte string contained within the attribute or %NULL.
462 _g_file_attribute_value_get_byte_string (const GFileAttributeValue
*attr
)
467 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
, NULL
);
469 return attr
->u
.string
;
473 * g_file_attribute_value_get_boolean:
474 * @attr: a #GFileAttributeValue.
476 * Gets the boolean value from a file attribute value. If the value is not the
477 * right type then %FALSE will be returned.
479 * Returns: the boolean value contained within the attribute, or %FALSE.
482 _g_file_attribute_value_get_boolean (const GFileAttributeValue
*attr
)
487 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_BOOLEAN
, FALSE
);
489 return attr
->u
.boolean
;
493 * g_file_attribute_value_get_uint32:
494 * @attr: a #GFileAttributeValue.
496 * Gets the unsigned 32-bit integer from a file attribute value. If the value
497 * is not the right type then %0 will be returned.
499 * Returns: the unsigned 32-bit integer from the attribute, or %0.
502 _g_file_attribute_value_get_uint32 (const GFileAttributeValue
*attr
)
507 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_UINT32
, 0);
509 return attr
->u
.uint32
;
513 * g_file_attribute_value_get_int32:
514 * @attr: a #GFileAttributeValue.
516 * Gets the signed 32-bit integer from a file attribute value. If the value
517 * is not the right type then %0 will be returned.
519 * Returns: the signed 32-bit integer from the attribute, or %0.
522 _g_file_attribute_value_get_int32 (const GFileAttributeValue
*attr
)
527 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_INT32
, 0);
529 return attr
->u
.int32
;
533 * g_file_attribute_value_get_uint64:
534 * @attr: a #GFileAttributeValue.
536 * Gets the unsigned 64-bit integer from a file attribute value. If the value
537 * is not the right type then %0 will be returned.
539 * Returns: the unsigned 64-bit integer from the attribute, or %0.
542 _g_file_attribute_value_get_uint64 (const GFileAttributeValue
*attr
)
547 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_UINT64
, 0);
549 return attr
->u
.uint64
;
553 * g_file_attribute_value_get_int64:
554 * @attr: a #GFileAttributeValue.
556 * Gets the signed 64-bit integer from a file attribute value. If the value
557 * is not the right type then %0 will be returned.
559 * Returns: the signed 64-bit integer from the attribute, or %0.
562 _g_file_attribute_value_get_int64 (const GFileAttributeValue
*attr
)
567 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_INT64
, 0);
569 return attr
->u
.int64
;
573 * g_file_attribute_value_get_object:
574 * @attr: a #GFileAttributeValue.
576 * Gets the GObject from a file attribute value. If the value
577 * is not the right type then %NULL will be returned.
579 * Returns: the GObject from the attribute, or %0.
582 _g_file_attribute_value_get_object (const GFileAttributeValue
*attr
)
587 g_return_val_if_fail (attr
->type
== G_FILE_ATTRIBUTE_TYPE_OBJECT
, NULL
);
594 _g_file_attribute_value_set_from_pointer (GFileAttributeValue
*value
,
595 GFileAttributeType type
,
599 _g_file_attribute_value_clear (value
);
603 case G_FILE_ATTRIBUTE_TYPE_STRING
:
604 case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
:
606 value
->u
.string
= g_strdup (value_p
);
608 value
->u
.string
= value_p
;
611 case G_FILE_ATTRIBUTE_TYPE_OBJECT
:
613 value
->u
.obj
= g_object_ref (value_p
);
615 value
->u
.obj
= value_p
;
618 case G_FILE_ATTRIBUTE_TYPE_BOOLEAN
:
619 value
->u
.boolean
= *(gboolean
*)value_p
;
622 case G_FILE_ATTRIBUTE_TYPE_UINT32
:
623 value
->u
.uint32
= *(guint32
*)value_p
;
626 case G_FILE_ATTRIBUTE_TYPE_INT32
:
627 value
->u
.int32
= *(gint32
*)value_p
;
630 case G_FILE_ATTRIBUTE_TYPE_UINT64
:
631 value
->u
.uint64
= *(guint64
*)value_p
;
634 case G_FILE_ATTRIBUTE_TYPE_INT64
:
635 value
->u
.int64
= *(gint64
*)value_p
;
638 g_warning ("Unknown type specified in g_file_info_set_attribute\n");
644 * g_file_attribute_value_set_string:
645 * @attr: a #GFileAttributeValue.
646 * @string: a string to set within the type.
648 * Sets the attribute value to a given string.
652 _g_file_attribute_value_set_string (GFileAttributeValue
*attr
,
655 g_return_if_fail (attr
!= NULL
);
656 g_return_if_fail (string
!= NULL
);
658 _g_file_attribute_value_clear (attr
);
659 attr
->type
= G_FILE_ATTRIBUTE_TYPE_STRING
;
660 attr
->u
.string
= g_strdup (string
);
664 * g_file_attribute_value_set_byte_string:
665 * @attr: a #GFileAttributeValue.
666 * @string: a byte string to set within the type.
668 * Sets the attribute value to a given byte string.
672 _g_file_attribute_value_set_byte_string (GFileAttributeValue
*attr
,
675 g_return_if_fail (attr
!= NULL
);
676 g_return_if_fail (string
!= NULL
);
678 _g_file_attribute_value_clear (attr
);
679 attr
->type
= G_FILE_ATTRIBUTE_TYPE_BYTE_STRING
;
680 attr
->u
.string
= g_strdup (string
);
684 * g_file_attribute_value_set_boolean:
685 * @attr: a #GFileAttributeValue.
686 * @value: a #gboolean to set within the type.
688 * Sets the attribute value to the given boolean value.
692 _g_file_attribute_value_set_boolean (GFileAttributeValue
*attr
,
695 g_return_if_fail (attr
!= NULL
);
697 _g_file_attribute_value_clear (attr
);
698 attr
->type
= G_FILE_ATTRIBUTE_TYPE_BOOLEAN
;
699 attr
->u
.boolean
= !!value
;
703 * g_file_attribute_value_set_uint32:
704 * @attr: a #GFileAttributeValue.
705 * @value: a #guint32 to set within the type.
707 * Sets the attribute value to the given unsigned 32-bit integer.
711 _g_file_attribute_value_set_uint32 (GFileAttributeValue
*attr
,
714 g_return_if_fail (attr
!= NULL
);
716 _g_file_attribute_value_clear (attr
);
717 attr
->type
= G_FILE_ATTRIBUTE_TYPE_UINT32
;
718 attr
->u
.uint32
= value
;
722 * g_file_attribute_value_set_int32:
723 * @attr: a #GFileAttributeValue.
724 * @value: a #gint32 to set within the type.
726 * Sets the attribute value to the given signed 32-bit integer.
730 _g_file_attribute_value_set_int32 (GFileAttributeValue
*attr
,
733 g_return_if_fail (attr
!= NULL
);
735 _g_file_attribute_value_clear (attr
);
736 attr
->type
= G_FILE_ATTRIBUTE_TYPE_INT32
;
737 attr
->u
.int32
= value
;
741 * g_file_attribute_value_set_uint64:
742 * @attr: a #GFileAttributeValue.
743 * @value: a #guint64 to set within the type.
745 * Sets the attribute value to a given unsigned 64-bit integer.
749 _g_file_attribute_value_set_uint64 (GFileAttributeValue
*attr
,
752 g_return_if_fail (attr
!= NULL
);
754 _g_file_attribute_value_clear (attr
);
755 attr
->type
= G_FILE_ATTRIBUTE_TYPE_UINT64
;
756 attr
->u
.uint64
= value
;
760 * g_file_attribute_value_set_int64:
761 * @attr: a #GFileAttributeValue.
762 * @value: a #gint64 to set within the type.
764 * Sets the attribute value to a given signed 64-bit integer.
768 _g_file_attribute_value_set_int64 (GFileAttributeValue
*attr
,
771 g_return_if_fail (attr
!= NULL
);
773 _g_file_attribute_value_clear (attr
);
774 attr
->type
= G_FILE_ATTRIBUTE_TYPE_INT64
;
775 attr
->u
.int64
= value
;
779 * g_file_attribute_value_set_object:
780 * @attr: a #GFileAttributeValue.
783 * Sets the attribute to contain the value @obj.
784 * The @attr references the GObject internally.
788 _g_file_attribute_value_set_object (GFileAttributeValue
*attr
,
791 g_return_if_fail (attr
!= NULL
);
792 g_return_if_fail (obj
!= NULL
);
794 _g_file_attribute_value_clear (attr
);
795 attr
->type
= G_FILE_ATTRIBUTE_TYPE_OBJECT
;
796 attr
->u
.obj
= g_object_ref (obj
);
800 GFileAttributeInfoList
public;
803 } GFileAttributeInfoListPriv
;
806 list_update_public (GFileAttributeInfoListPriv
*priv
)
808 priv
->public.infos
= (GFileAttributeInfo
*)priv
->array
->data
;
809 priv
->public.n_infos
= priv
->array
->len
;
813 * g_file_attribute_info_list_new:
815 * Creates a new file attribute info list.
817 * Returns: a #GFileAttributeInfoList.
819 GFileAttributeInfoList
*
820 g_file_attribute_info_list_new (void)
822 GFileAttributeInfoListPriv
*priv
;
824 priv
= g_new0 (GFileAttributeInfoListPriv
, 1);
827 priv
->array
= g_array_new (TRUE
, FALSE
, sizeof (GFileAttributeInfo
));
829 list_update_public (priv
);
831 return (GFileAttributeInfoList
*)priv
;
835 * g_file_attribute_info_list_dup:
836 * @list: a #GFileAttributeInfoList to duplicate.
838 * Makes a duplicate of a file attribute info list.
840 * Returns: a copy of the given @list.
842 GFileAttributeInfoList
*
843 g_file_attribute_info_list_dup (GFileAttributeInfoList
*list
)
845 GFileAttributeInfoListPriv
*new;
848 g_return_val_if_fail (list
!= NULL
, NULL
);
850 new = g_new0 (GFileAttributeInfoListPriv
, 1);
852 new->array
= g_array_new (TRUE
, FALSE
, sizeof (GFileAttributeInfo
));
854 g_array_set_size (new->array
, list
->n_infos
);
855 list_update_public (new);
856 for (i
= 0; i
< list
->n_infos
; i
++)
858 new->public.infos
[i
].name
= g_strdup (list
->infos
[i
].name
);
859 new->public.infos
[i
].type
= list
->infos
[i
].type
;
860 new->public.infos
[i
].flags
= list
->infos
[i
].flags
;
863 return (GFileAttributeInfoList
*)new;
867 * g_file_attribute_info_list_ref:
868 * @list: a #GFileAttributeInfoList to reference.
870 * References a file attribute info list.
872 * Returns: #GFileAttributeInfoList or %NULL on error.
874 GFileAttributeInfoList
*
875 g_file_attribute_info_list_ref (GFileAttributeInfoList
*list
)
877 GFileAttributeInfoListPriv
*priv
= (GFileAttributeInfoListPriv
*)list
;
879 g_return_val_if_fail (list
!= NULL
, NULL
);
880 g_return_val_if_fail (priv
->ref_count
> 0, NULL
);
882 g_atomic_int_inc (&priv
->ref_count
);
888 * g_file_attribute_info_list_unref:
889 * @list: The #GFileAttributeInfoList to unreference.
891 * Removes a reference from the given @list. If the reference count
892 * falls to zero, the @list is deleted.
895 g_file_attribute_info_list_unref (GFileAttributeInfoList
*list
)
897 GFileAttributeInfoListPriv
*priv
= (GFileAttributeInfoListPriv
*)list
;
900 g_return_if_fail (list
!= NULL
);
901 g_return_if_fail (priv
->ref_count
> 0);
903 if (g_atomic_int_dec_and_test (&priv
->ref_count
))
905 for (i
= 0; i
< list
->n_infos
; i
++)
906 g_free (list
->infos
[i
].name
);
907 g_array_free (priv
->array
, TRUE
);
912 g_file_attribute_info_list_bsearch (GFileAttributeInfoList
*list
,
922 mid
= start
+ (end
- start
) / 2;
924 if (strcmp (name
, list
->infos
[mid
].name
) < 0)
926 else if (strcmp (name
, list
->infos
[mid
].name
) > 0)
935 * g_file_attribute_info_list_lookup:
936 * @list: a #GFileAttributeInfoList.
937 * @name: the name of the attribute to lookup.
939 * Gets the file attribute with the name @name from @list.
941 * Returns: a #GFileAttributeInfo for the @name, or %NULL if an
942 * attribute isn't found.
944 const GFileAttributeInfo
*
945 g_file_attribute_info_list_lookup (GFileAttributeInfoList
*list
,
950 g_return_val_if_fail (list
!= NULL
, NULL
);
951 g_return_val_if_fail (name
!= NULL
, NULL
);
953 i
= g_file_attribute_info_list_bsearch (list
, name
);
955 if (i
< list
->n_infos
&& strcmp (list
->infos
[i
].name
, name
) == 0)
956 return &list
->infos
[i
];
962 * g_file_attribute_info_list_add:
963 * @list: a #GFileAttributeInfoList.
964 * @name: the name of the attribute to add.
965 * @type: the #GFileAttributeType for the attribute.
966 * @flags: #GFileAttributeInfoFlags for the attribute.
968 * Adds a new attribute with @name to the @list, setting
969 * its @type and @flags.
972 g_file_attribute_info_list_add (GFileAttributeInfoList
*list
,
974 GFileAttributeType type
,
975 GFileAttributeInfoFlags flags
)
977 GFileAttributeInfoListPriv
*priv
= (GFileAttributeInfoListPriv
*)list
;
978 GFileAttributeInfo info
;
981 g_return_if_fail (list
!= NULL
);
982 g_return_if_fail (name
!= NULL
);
984 i
= g_file_attribute_info_list_bsearch (list
, name
);
986 if (i
< list
->n_infos
&& strcmp (list
->infos
[i
].name
, name
) == 0)
988 list
->infos
[i
].type
= type
;
992 info
.name
= g_strdup (name
);
995 g_array_insert_vals (priv
->array
, i
, &info
, 1);
997 list_update_public (priv
);
1000 #define __G_FILE_ATTRIBUTE_C__
1001 #include "gioaliasdef.c"