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>
114 * Please note that these are not all of the possible namespaces.
115 * More namespaces can be added from GIO modules or by individual applications.
116 * For more information about writing GIO modules, see #GIOModule.
118 * <!-- TODO: Implementation note about using extended attributes on supported
122 * <title>GFileAttributes Built-in Keys and Value Types</title>
123 * <tgroup cols='3' align='left'><thead>
124 * <row><entry>Enum Value</entry><entry>Namespace:Key</entry><entry>Value Type</entry></row>
126 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TYPE</entry><entry>standard::type</entry><entry>uint32 (#GFileType)</entry></row>
127 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN</entry><entry>standard::is-hidden</entry><entry>boolean</entry></row>
128 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP</entry><entry>standard::is-backup</entry><entry>boolean</entry></row>
129 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK</entry><entry>standard::is-symlink</entry><entry>boolean</entry></row>
130 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL</entry><entry>standard::is-virtual</entry><entry>boolean</entry></row>
131 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_NAME</entry><entry>standard::name</entry><entry>byte string</entry></row>
132 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME</entry><entry>standard::display-name</entry><entry>string</entry></row>
133 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME</entry><entry>standard::edit-name</entry><entry>string</entry></row>
134 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_ICON</entry><entry>standard::icon</entry><entry>object (#GIcon)</entry></row>
135 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE</entry><entry>standard::content-type</entry><entry>string</entry></row>
136 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE</entry><entry>standard::fast-content-type</entry><entry>string</entry></row>
137 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SIZE</entry><entry>standard::size</entry><entry>uint64</entry></row>
138 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET</entry><entry>standard::symlink-target</entry><entry>byte string</entry></row>
139 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TARGET_URI</entry><entry>standard::target-uri</entry><entry>string</entry></row>
140 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER</entry><entry>standard::sort-order</entry><entry>int32</entry></row>
141 * <row><entry>%G_FILE_ATTRIBUTE_ETAG_VALUE</entry><entry>etag::value</entry><entry>string</entry></row>
142 * <row><entry>%G_FILE_ATTRIBUTE_ID_FILE</entry><entry>id::file</entry><entry>string</entry></row>
143 * <row><entry>%G_FILE_ATTRIBUTE_ID_FILESYSTEM</entry><entry>id::filesystem</entry><entry>string</entry></row>
144 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_READ</entry><entry>access::can-read</entry><entry>boolean</entry></row>
145 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE</entry><entry>access::can-write</entry><entry>boolean</entry></row>
146 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE</entry><entry>access::can-execute</entry><entry>boolean</entry></row>
147 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE</entry><entry>access::can-delete</entry><entry>boolean</entry></row>
148 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH</entry><entry>access::can-trash</entry><entry>boolean</entry></row>
149 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME</entry><entry>access::can-rename</entry><entry>boolean</entry></row>
150 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT</entry><entry>mountable::can-mount</entry><entry>boolean</entry></row>
151 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT</entry><entry>mountable::can-unmount</entry><entry>boolean</entry></row>
152 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT</entry><entry>mountable::can-eject</entry><entry>boolean</entry></row>
153 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE</entry><entry>mountable::unix-device</entry><entry>uint32</entry></row>
154 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI</entry><entry>mountable::hal-udi</entry><entry>string</entry></row>
155 * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED</entry><entry>time::modified</entry><entry>uint64</entry></row>
156 * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC</entry><entry>time::modified-usec</entry><entry>uint32</entry></row>
157 * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS</entry><entry>time::access</entry><entry>uint64</entry></row>
158 * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS_USEC</entry><entry>time::access-usec</entry><entry>uint32</entry></row>
159 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED</entry><entry>time::changed</entry><entry>uint64</entry></row>
160 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED_USEC</entry><entry>time::changed-usec</entry><entry>uint32</entry></row>
161 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED</entry><entry>time::created</entry><entry>uint64</entry></row>
162 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED_USEC</entry><entry>time::created-usec</entry><entry>uint32</entry></row>
163 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_DEVICE</entry><entry>unix::device</entry><entry>uint32</entry></row>
164 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_INODE</entry><entry>unix::inode</entry><entry>uint64</entry></row>
165 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_MODE</entry><entry>unix::mode</entry><entry>uint32</entry></row>
166 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_NLINK</entry><entry>unix::nlink</entry><entry>uint32</entry></row>
167 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_UID</entry><entry>unix::uid</entry><entry>uint32</entry></row>
168 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_GID</entry><entry>unix::gid</entry><entry>uint32</entry></row>
169 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_RDEV</entry><entry>unix::rdev</entry><entry>uint32</entry></row>
170 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE</entry><entry>unix::block-size</entry><entry>uint32</entry></row>
171 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCKS</entry><entry>unix::blocks</entry><entry>uint64</entry></row>
172 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT</entry><entry>unix::is-mountpoint</entry><entry>boolean</entry></row>
173 * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE</entry><entry>dos::is-archive</entry><entry>boolean</entry></row>
174 * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_SYSTEM</entry><entry>dos::is-system</entry><entry>boolean</entry></row>
175 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER</entry><entry>owner::user</entry><entry>string</entry></row>
176 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER_REAL</entry><entry>owner::user-real</entry><entry>string</entry></row>
177 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_GROUP</entry><entry>owner::group</entry><entry>string</entry></row>
178 * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAIL_PATH</entry><entry>thumbnail::path</entry><entry>bytestring</entry></row>
179 * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAILING_FAILED</entry><entry>thumbnail::failed</entry><entry>boolean</entry></row>
180 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE</entry><entry>filesystem::size</entry><entry>uint64</entry></row>
181 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_FREE</entry><entry>filesystem::free</entry><entry>uint64</entry></row>
182 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_TYPE</entry><entry>filesystem::type</entry><entry>string</entry></row>
183 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_READONLY</entry><entry>filesystem::readonly</entry><entry>boolean</entry></row>
184 * <row><entry>%G_FILE_ATTRIBUTE_GVFS_BACKEND</entry><entry>gvfs::backend</entry><entry>string</entry></row>
185 * </tbody></tgroup></table></para>
190 * _g_file_attribute_value_free:
191 * @attr: a #GFileAttributeValue.
193 * Frees the memory used by @attr.
197 _g_file_attribute_value_free (GFileAttributeValue *attr)
199 g_return_if_fail (attr != NULL);
201 _g_file_attribute_value_clear (attr);
206 * _g_file_attribute_value_clear:
207 * @attr: a #GFileAttributeValue.
209 * Clears the value of @attr and sets its type to
210 * %G_FILE_ATTRIBUTE_TYPE_INVALID.
214 _g_file_attribute_value_clear (GFileAttributeValue *attr)
216 g_return_if_fail (attr != NULL);
218 if (attr->type == G_FILE_ATTRIBUTE_TYPE_STRING ||
219 attr->type == G_FILE_ATTRIBUTE_TYPE_BYTE_STRING)
220 g_free (attr->u.string);
222 if (attr->type == G_FILE_ATTRIBUTE_TYPE_OBJECT &&
224 g_object_unref (attr->u.obj);
226 attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
230 * g_file_attribute_value_set:
231 * @attr: a #GFileAttributeValue to set the value in.
232 * @new_value: a #GFileAttributeValue to get the value from.
234 * Sets an attribute's value from another attribute.
237 _g_file_attribute_value_set (GFileAttributeValue *attr,
238 const GFileAttributeValue *new_value)
240 g_return_if_fail (attr != NULL);
241 g_return_if_fail (new_value != NULL);
243 _g_file_attribute_value_clear (attr);
246 if (attr->type == G_FILE_ATTRIBUTE_TYPE_STRING ||
247 attr->type == G_FILE_ATTRIBUTE_TYPE_BYTE_STRING)
248 attr->u.string = g_strdup (attr->u.string);
250 if (attr->type == G_FILE_ATTRIBUTE_TYPE_OBJECT &&
252 g_object_ref (attr->u.obj);
256 * _g_file_attribute_value_new:
258 * Creates a new file attribute.
260 * Returns: a #GFileAttributeValue.
262 GFileAttributeValue *
263 _g_file_attribute_value_new (void)
265 GFileAttributeValue *attr;
267 attr = g_new (GFileAttributeValue, 1);
268 attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
273 _g_file_attribute_value_peek_as_pointer (GFileAttributeValue *attr)
275 switch (attr->type) {
276 case G_FILE_ATTRIBUTE_TYPE_STRING:
277 case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING:
278 return attr->u.string;
279 case G_FILE_ATTRIBUTE_TYPE_OBJECT:
282 return (gpointer) &attr->u;
287 * g_file_attribute_value_dup:
288 * @other: a #GFileAttributeValue to duplicate.
290 * Duplicates a file attribute.
292 * Returns: a duplicate of the @other.
294 GFileAttributeValue *
295 _g_file_attribute_value_dup (const GFileAttributeValue *other)
297 GFileAttributeValue *attr;
299 g_return_val_if_fail (other != NULL, NULL);
301 attr = g_new (GFileAttributeValue, 1);
302 attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
303 _g_file_attribute_value_set (attr, other);
310 return c >= 32 && c <= 126 && c != '\\';
314 escape_byte_string (const char *str)
318 char *escaped_val, *p;
320 char *hex_digits = "0123456789abcdef";
325 for (i = 0; i < len; i++)
327 if (!valid_char (str[i]))
331 if (num_invalid == 0)
332 return g_strdup (str);
335 escaped_val = g_malloc (len + num_invalid*3 + 1);
338 for (i = 0; i < len; i++)
347 *p++ = hex_digits[(c >> 8) & 0xf];
348 *p++ = hex_digits[c & 0xf];
357 * g_file_attribute_value_as_string:
358 * @attr: a #GFileAttributeValue.
360 * Converts a #GFileAttributeValue to a string for display.
361 * The returned string should be freed when no longer needed.
363 * Returns: a string from the @attr, %NULL on error, or "<invalid>"
364 * if @attr is of type %G_FILE_ATTRIBUTE_TYPE_INVALID.
367 _g_file_attribute_value_as_string (const GFileAttributeValue *attr)
371 g_return_val_if_fail (attr != NULL, NULL);
375 case G_FILE_ATTRIBUTE_TYPE_STRING:
376 str = g_strdup (attr->u.string);
378 case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING:
379 str = escape_byte_string (attr->u.string);
381 case G_FILE_ATTRIBUTE_TYPE_BOOLEAN:
382 str = g_strdup_printf ("%s", attr->u.boolean?"TRUE":"FALSE");
384 case G_FILE_ATTRIBUTE_TYPE_UINT32:
385 str = g_strdup_printf ("%u", (unsigned int)attr->u.uint32);
387 case G_FILE_ATTRIBUTE_TYPE_INT32:
388 str = g_strdup_printf ("%i", (int)attr->u.int32);
390 case G_FILE_ATTRIBUTE_TYPE_UINT64:
391 str = g_strdup_printf ("%"G_GUINT64_FORMAT, attr->u.uint64);
393 case G_FILE_ATTRIBUTE_TYPE_INT64:
394 str = g_strdup_printf ("%"G_GINT64_FORMAT, attr->u.int64);
396 case G_FILE_ATTRIBUTE_TYPE_OBJECT:
397 str = g_strdup_printf ("%s:%p", g_type_name_from_instance
398 ((GTypeInstance *) attr->u.obj),
402 g_warning ("Invalid type in GFileInfo attribute");
403 str = g_strdup ("<invalid>");
411 * g_file_attribute_value_get_string:
412 * @attr: a #GFileAttributeValue.
414 * Gets the string from a file attribute value. If the value is not the
415 * right type then %NULL will be returned.
417 * Returns: the string value contained within the attribute, or %NULL.
420 _g_file_attribute_value_get_string (const GFileAttributeValue *attr)
425 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_STRING, NULL);
427 return attr->u.string;
431 * g_file_attribute_value_get_byte_string:
432 * @attr: a #GFileAttributeValue.
434 * Gets the byte string from a file attribute value. If the value is not the
435 * right type then %NULL will be returned.
437 * Returns: the byte string contained within the attribute or %NULL.
440 _g_file_attribute_value_get_byte_string (const GFileAttributeValue *attr)
445 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, NULL);
447 return attr->u.string;
451 * g_file_attribute_value_get_boolean:
452 * @attr: a #GFileAttributeValue.
454 * Gets the boolean value from a file attribute value. If the value is not the
455 * right type then %FALSE will be returned.
457 * Returns: the boolean value contained within the attribute, or %FALSE.
460 _g_file_attribute_value_get_boolean (const GFileAttributeValue *attr)
465 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_BOOLEAN, FALSE);
467 return attr->u.boolean;
471 * g_file_attribute_value_get_uint32:
472 * @attr: a #GFileAttributeValue.
474 * Gets the unsigned 32-bit integer from a file attribute value. If the value
475 * is not the right type then %0 will be returned.
477 * Returns: the unsigned 32-bit integer from the attribute, or %0.
480 _g_file_attribute_value_get_uint32 (const GFileAttributeValue *attr)
485 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_UINT32, 0);
487 return attr->u.uint32;
491 * g_file_attribute_value_get_int32:
492 * @attr: a #GFileAttributeValue.
494 * Gets the signed 32-bit integer from a file attribute value. If the value
495 * is not the right type then %0 will be returned.
497 * Returns: the signed 32-bit integer from the attribute, or %0.
500 _g_file_attribute_value_get_int32 (const GFileAttributeValue *attr)
505 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_INT32, 0);
507 return attr->u.int32;
511 * g_file_attribute_value_get_uint64:
512 * @attr: a #GFileAttributeValue.
514 * Gets the unsigned 64-bit integer from a file attribute value. If the value
515 * is not the right type then %0 will be returned.
517 * Returns: the unsigned 64-bit integer from the attribute, or %0.
520 _g_file_attribute_value_get_uint64 (const GFileAttributeValue *attr)
525 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_UINT64, 0);
527 return attr->u.uint64;
531 * g_file_attribute_value_get_int64:
532 * @attr: a #GFileAttributeValue.
534 * Gets the signed 64-bit integer from a file attribute value. If the value
535 * is not the right type then %0 will be returned.
537 * Returns: the signed 64-bit integer from the attribute, or %0.
540 _g_file_attribute_value_get_int64 (const GFileAttributeValue *attr)
545 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_INT64, 0);
547 return attr->u.int64;
551 * g_file_attribute_value_get_object:
552 * @attr: a #GFileAttributeValue.
554 * Gets the GObject from a file attribute value. If the value
555 * is not the right type then %NULL will be returned.
557 * Returns: the GObject from the attribute, or %0.
560 _g_file_attribute_value_get_object (const GFileAttributeValue *attr)
565 g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_OBJECT, NULL);
572 _g_file_attribute_value_set_from_pointer (GFileAttributeValue *value,
573 GFileAttributeType type,
577 _g_file_attribute_value_clear (value);
581 case G_FILE_ATTRIBUTE_TYPE_STRING:
582 case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING:
584 value->u.string = g_strdup (value_p);
586 value->u.string = value_p;
589 case G_FILE_ATTRIBUTE_TYPE_OBJECT:
591 value->u.obj = g_object_ref (value_p);
593 value->u.obj = value_p;
596 case G_FILE_ATTRIBUTE_TYPE_BOOLEAN:
597 value->u.boolean = *(gboolean *)value_p;
600 case G_FILE_ATTRIBUTE_TYPE_UINT32:
601 value->u.uint32 = *(guint32 *)value_p;
604 case G_FILE_ATTRIBUTE_TYPE_INT32:
605 value->u.int32 = *(gint32 *)value_p;
608 case G_FILE_ATTRIBUTE_TYPE_UINT64:
609 value->u.uint64 = *(guint64 *)value_p;
612 case G_FILE_ATTRIBUTE_TYPE_INT64:
613 value->u.int64 = *(gint64 *)value_p;
616 g_warning ("Unknown type specified in g_file_info_set_attribute\n");
622 * g_file_attribute_value_set_string:
623 * @attr: a #GFileAttributeValue.
624 * @string: a string to set within the type.
626 * Sets the attribute value to a given string.
630 _g_file_attribute_value_set_string (GFileAttributeValue *attr,
633 g_return_if_fail (attr != NULL);
634 g_return_if_fail (string != NULL);
636 _g_file_attribute_value_clear (attr);
637 attr->type = G_FILE_ATTRIBUTE_TYPE_STRING;
638 attr->u.string = g_strdup (string);
642 * g_file_attribute_value_set_byte_string:
643 * @attr: a #GFileAttributeValue.
644 * @string: a byte string to set within the type.
646 * Sets the attribute value to a given byte string.
650 _g_file_attribute_value_set_byte_string (GFileAttributeValue *attr,
653 g_return_if_fail (attr != NULL);
654 g_return_if_fail (string != NULL);
656 _g_file_attribute_value_clear (attr);
657 attr->type = G_FILE_ATTRIBUTE_TYPE_BYTE_STRING;
658 attr->u.string = g_strdup (string);
662 * g_file_attribute_value_set_boolean:
663 * @attr: a #GFileAttributeValue.
664 * @value: a #gboolean to set within the type.
666 * Sets the attribute value to the given boolean value.
670 _g_file_attribute_value_set_boolean (GFileAttributeValue *attr,
673 g_return_if_fail (attr != NULL);
675 _g_file_attribute_value_clear (attr);
676 attr->type = G_FILE_ATTRIBUTE_TYPE_BOOLEAN;
677 attr->u.boolean = !!value;
681 * g_file_attribute_value_set_uint32:
682 * @attr: a #GFileAttributeValue.
683 * @value: a #guint32 to set within the type.
685 * Sets the attribute value to the given unsigned 32-bit integer.
689 _g_file_attribute_value_set_uint32 (GFileAttributeValue *attr,
692 g_return_if_fail (attr != NULL);
694 _g_file_attribute_value_clear (attr);
695 attr->type = G_FILE_ATTRIBUTE_TYPE_UINT32;
696 attr->u.uint32 = value;
700 * g_file_attribute_value_set_int32:
701 * @attr: a #GFileAttributeValue.
702 * @value: a #gint32 to set within the type.
704 * Sets the attribute value to the given signed 32-bit integer.
708 _g_file_attribute_value_set_int32 (GFileAttributeValue *attr,
711 g_return_if_fail (attr != NULL);
713 _g_file_attribute_value_clear (attr);
714 attr->type = G_FILE_ATTRIBUTE_TYPE_INT32;
715 attr->u.int32 = value;
719 * g_file_attribute_value_set_uint64:
720 * @attr: a #GFileAttributeValue.
721 * @value: a #guint64 to set within the type.
723 * Sets the attribute value to a given unsigned 64-bit integer.
727 _g_file_attribute_value_set_uint64 (GFileAttributeValue *attr,
730 g_return_if_fail (attr != NULL);
732 _g_file_attribute_value_clear (attr);
733 attr->type = G_FILE_ATTRIBUTE_TYPE_UINT64;
734 attr->u.uint64 = value;
738 * g_file_attribute_value_set_int64:
739 * @attr: a #GFileAttributeValue.
740 * @value: a #gint64 to set within the type.
742 * Sets the attribute value to a given signed 64-bit integer.
746 _g_file_attribute_value_set_int64 (GFileAttributeValue *attr,
749 g_return_if_fail (attr != NULL);
751 _g_file_attribute_value_clear (attr);
752 attr->type = G_FILE_ATTRIBUTE_TYPE_INT64;
753 attr->u.int64 = value;
757 * g_file_attribute_value_set_object:
758 * @attr: a #GFileAttributeValue.
761 * Sets the attribute to contain the value @obj.
762 * The @attr references the GObject internally.
766 _g_file_attribute_value_set_object (GFileAttributeValue *attr,
769 g_return_if_fail (attr != NULL);
770 g_return_if_fail (obj != NULL);
772 _g_file_attribute_value_clear (attr);
773 attr->type = G_FILE_ATTRIBUTE_TYPE_OBJECT;
774 attr->u.obj = g_object_ref (obj);
778 GFileAttributeInfoList public;
781 } GFileAttributeInfoListPriv;
784 list_update_public (GFileAttributeInfoListPriv *priv)
786 priv->public.infos = (GFileAttributeInfo *)priv->array->data;
787 priv->public.n_infos = priv->array->len;
791 * g_file_attribute_info_list_new:
793 * Creates a new file attribute info list.
795 * Returns: a #GFileAttributeInfoList.
797 GFileAttributeInfoList *
798 g_file_attribute_info_list_new (void)
800 GFileAttributeInfoListPriv *priv;
802 priv = g_new0 (GFileAttributeInfoListPriv, 1);
805 priv->array = g_array_new (TRUE, FALSE, sizeof (GFileAttributeInfo));
807 list_update_public (priv);
809 return (GFileAttributeInfoList *)priv;
813 * g_file_attribute_info_list_dup:
814 * @list: a #GFileAttributeInfoList to duplicate.
816 * Makes a duplicate of a file attribute info list.
818 * Returns: a copy of the given @list.
820 GFileAttributeInfoList *
821 g_file_attribute_info_list_dup (GFileAttributeInfoList *list)
823 GFileAttributeInfoListPriv *new;
826 g_return_val_if_fail (list != NULL, NULL);
828 new = g_new0 (GFileAttributeInfoListPriv, 1);
830 new->array = g_array_new (TRUE, FALSE, sizeof (GFileAttributeInfo));
832 g_array_set_size (new->array, list->n_infos);
833 list_update_public (new);
834 for (i = 0; i < list->n_infos; i++)
836 new->public.infos[i].name = g_strdup (list->infos[i].name);
837 new->public.infos[i].type = list->infos[i].type;
838 new->public.infos[i].flags = list->infos[i].flags;
841 return (GFileAttributeInfoList *)new;
845 * g_file_attribute_info_list_ref:
846 * @list: a #GFileAttributeInfoList to reference.
848 * References a file attribute info list.
850 * Returns: #GFileAttributeInfoList or %NULL on error.
852 GFileAttributeInfoList *
853 g_file_attribute_info_list_ref (GFileAttributeInfoList *list)
855 GFileAttributeInfoListPriv *priv = (GFileAttributeInfoListPriv *)list;
857 g_return_val_if_fail (list != NULL, NULL);
858 g_return_val_if_fail (priv->ref_count > 0, NULL);
860 g_atomic_int_inc (&priv->ref_count);
866 * g_file_attribute_info_list_unref:
867 * @list: The #GFileAttributeInfoList to unreference.
869 * Removes a reference from the given @list. If the reference count
870 * falls to zero, the @list is deleted.
873 g_file_attribute_info_list_unref (GFileAttributeInfoList *list)
875 GFileAttributeInfoListPriv *priv = (GFileAttributeInfoListPriv *)list;
878 g_return_if_fail (list != NULL);
879 g_return_if_fail (priv->ref_count > 0);
881 if (g_atomic_int_dec_and_test (&priv->ref_count))
883 for (i = 0; i < list->n_infos; i++)
884 g_free (list->infos[i].name);
885 g_array_free (priv->array, TRUE);
890 g_file_attribute_info_list_bsearch (GFileAttributeInfoList *list,
900 mid = start + (end - start) / 2;
902 if (strcmp (name, list->infos[mid].name) < 0)
904 else if (strcmp (name, list->infos[mid].name) > 0)
913 * g_file_attribute_info_list_lookup:
914 * @list: a #GFileAttributeInfoList.
915 * @name: the name of the attribute to lookup.
917 * Gets the file attribute with the name @name from @list.
919 * Returns: a #GFileAttributeInfo for the @name, or %NULL if an
920 * attribute isn't found.
922 const GFileAttributeInfo *
923 g_file_attribute_info_list_lookup (GFileAttributeInfoList *list,
928 g_return_val_if_fail (list != NULL, NULL);
929 g_return_val_if_fail (name != NULL, NULL);
931 i = g_file_attribute_info_list_bsearch (list, name);
933 if (i < list->n_infos && strcmp (list->infos[i].name, name) == 0)
934 return &list->infos[i];
940 * g_file_attribute_info_list_add:
941 * @list: a #GFileAttributeInfoList.
942 * @name: the name of the attribute to add.
943 * @type: the #GFileAttributeType for the attribute.
944 * @flags: #GFileAttributeInfoFlags for the attribute.
946 * Adds a new attribute with @name to the @list, setting
947 * its @type and @flags.
950 g_file_attribute_info_list_add (GFileAttributeInfoList *list,
952 GFileAttributeType type,
953 GFileAttributeInfoFlags flags)
955 GFileAttributeInfoListPriv *priv = (GFileAttributeInfoListPriv *)list;
956 GFileAttributeInfo info;
959 g_return_if_fail (list != NULL);
960 g_return_if_fail (name != NULL);
962 i = g_file_attribute_info_list_bsearch (list, name);
964 if (i < list->n_infos && strcmp (list->infos[i].name, name) == 0)
966 list->infos[i].type = type;
970 info.name = g_strdup (name);
973 g_array_insert_vals (priv->array, i, &info, 1);
975 list_update_public (priv);
978 #define __G_FILE_ATTRIBUTE_C__
979 #include "gioaliasdef.c"