* 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., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: Alexander Larsson <alexl@redhat.com>
*/
* SECTION:gfileinfo
* @short_description: File Information and Attributes
* @include: gio/gio.h
- * @see_also: #GFile, <link linkend="gio-GFileAttribute">GFileAttribute</link>
+ * @see_also: #GFile, [GFileAttribute][gio-GFileAttribute]
*
* Functionality for manipulating basic metadata for files. #GFileInfo
* implements methods for getting information that all files should
* contain, and allows for manipulation of extended attributes.
*
- * See <link linkend="gio-GFileAttribute">GFileAttribute</link> for more
- * information on how GIO handles file attributes.
+ * See [GFileAttribute][gio-GFileAttribute] for more information on how
+ * GIO handles file attributes.
*
* To obtain a #GFileInfo for a #GFile, use g_file_query_info() (or its
* async variant). To obtain a #GFileInfo for a file input or output
REGISTER_ATTRIBUTE (STANDARD_SYMLINK_TARGET);
REGISTER_ATTRIBUTE (STANDARD_TARGET_URI);
REGISTER_ATTRIBUTE (STANDARD_SORT_ORDER);
+ REGISTER_ATTRIBUTE (STANDARD_SYMBOLIC_ICON);
REGISTER_ATTRIBUTE (ETAG_VALUE);
REGISTER_ATTRIBUTE (ID_FILE);
REGISTER_ATTRIBUTE (ID_FILESYSTEM);
REGISTER_ATTRIBUTE (OWNER_GROUP);
REGISTER_ATTRIBUTE (THUMBNAIL_PATH);
REGISTER_ATTRIBUTE (THUMBNAILING_FAILED);
+ REGISTER_ATTRIBUTE (THUMBNAIL_IS_VALID);
REGISTER_ATTRIBUTE (PREVIEW_ICON);
REGISTER_ATTRIBUTE (FILESYSTEM_SIZE);
REGISTER_ATTRIBUTE (FILESYSTEM_FREE);
* @src_info: source to copy attributes from.
* @dest_info: destination to copy attributes to.
*
- * Copies all of the #GFileAttribute<!-- -->s from @src_info to @dest_info.
+ * Copies all of the [GFileAttribute][gio-GFileAttribute]
+ * from @src_info to @dest_info.
**/
void
g_file_info_copy_into (GFileInfo *src_info,
*
* Lists the file info structure's attributes.
*
- * Returns: (array zero-terminated=1) (transfer full): a null-terminated array of strings of all of the
- * possible attribute types for the given @name_space, or
- * %NULL on error.
+ * Returns: (nullable) (array zero-terminated=1) (transfer full): a
+ * null-terminated array of strings of all of the possible attribute
+ * types for the given @name_space, or %NULL on error.
**/
char **
g_file_info_list_attributes (GFileInfo *info,
* @type: a #GFileAttributeType
* @value_p: pointer to the value
*
- * Sets the @attribute to contain the given value, if possible.
+ * Sets the @attribute to contain the given value, if possible. To unset the
+ * attribute, use %G_ATTRIBUTE_TYPE_INVALID for @type.
**/
void
g_file_info_set_attribute (GFileInfo *info,
* g_file_info_set_attribute_stringv:
* @info: a #GFileInfo.
* @attribute: a file attribute key
- * @attr_value: a %NULL terminated array of UTF-8 strings.
+ * @attr_value: (array) (element-type utf8): a %NULL terminated array of UTF-8 strings.
*
* Sets the @attribute to contain the given @attr_value,
* if possible.
/* Helper getters */
/**
+ * g_file_info_get_deletion_date:
+ * @info: a #GFileInfo.
+ *
+ * Returns the #GDateTime representing the deletion date of the file, as
+ * available in G_FILE_ATTRIBUTE_TRASH_DELETION_DATE. If the
+ * G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned.
+ *
+ * Returns: a #GDateTime, or %NULL.
+ *
+ * Since: 2.36
+ **/
+GDateTime *
+g_file_info_get_deletion_date (GFileInfo *info)
+{
+ static guint32 attr = 0;
+ GFileAttributeValue *value;
+ const char *date_str;
+ GTimeVal tv;
+
+ g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
+
+ if (attr == 0)
+ attr = lookup_attribute (G_FILE_ATTRIBUTE_TRASH_DELETION_DATE);
+
+ value = g_file_info_find_value (info, attr);
+ date_str = _g_file_attribute_value_get_string (value);
+ if (!date_str)
+ return NULL;
+
+ if (g_time_val_from_iso8601 (date_str, &tv) == FALSE)
+ return NULL;
+
+ return g_date_time_new_from_timeval_local (&tv);
+}
+
+/**
* g_file_info_get_file_type:
* @info: a #GFileInfo.
*
}
/**
+ * g_file_info_get_symbolic_icon:
+ * @info: a #GFileInfo.
+ *
+ * Gets the symbolic icon for a file.
+ *
+ * Returns: (transfer none): #GIcon for the given @info.
+ *
+ * Since: 2.34
+ **/
+GIcon *
+g_file_info_get_symbolic_icon (GFileInfo *info)
+{
+ static guint32 attr = 0;
+ GFileAttributeValue *value;
+ GObject *obj;
+
+ g_return_val_if_fail (G_IS_FILE_INFO (info), NULL);
+
+ if (attr == 0)
+ attr = lookup_attribute (G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON);
+
+ value = g_file_info_find_value (info, attr);
+ obj = _g_file_attribute_value_get_object (value);
+ if (G_IS_ICON (obj))
+ return G_ICON (obj);
+ return NULL;
+}
+
+/**
* g_file_info_get_content_type:
* @info: a #GFileInfo.
*
* g_file_info_get_etag:
* @info: a #GFileInfo.
*
- * Gets the <link linkend="gfile-etag">entity tag</link> for a given
+ * Gets the [entity tag][gfile-etag] for a given
* #GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE.
*
* Returns: a string containing the value of the "etag:value" attribute.
* @info: a #GFileInfo.
* @is_hidden: a #gboolean.
*
- * Sets the "is_hidden" attribute in a #GFileInfo according to @is_symlink.
+ * Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden.
* See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN.
**/
void
}
/**
+ * g_file_info_set_symbolic_icon:
+ * @info: a #GFileInfo.
+ * @icon: a #GIcon.
+ *
+ * Sets the symbolic icon for a given #GFileInfo.
+ * See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON.
+ *
+ * Since: 2.34
+ **/
+void
+g_file_info_set_symbolic_icon (GFileInfo *info,
+ GIcon *icon)
+{
+ static guint32 attr = 0;
+ GFileAttributeValue *value;
+
+ g_return_if_fail (G_IS_FILE_INFO (info));
+ g_return_if_fail (G_IS_ICON (icon));
+
+ if (attr == 0)
+ attr = lookup_attribute (G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON);
+
+ value = g_file_info_create_value (info, attr);
+ if (value)
+ _g_file_attribute_value_set_object (value, G_OBJECT (icon));
+}
+
+/**
* g_file_info_set_content_type:
* @info: a #GFileInfo.
- * @content_type: a content type. See <link linkend="gio-GContentType">GContentType</link>.
+ * @content_type: a content type. See [GContentType][gio-GContentType]
*
* Sets the content type attribute for a given #GFileInfo.
* See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE.
}
/**
- * g_file_info_set_modification_time
+ * g_file_info_set_modification_time:
* @info: a #GFileInfo.
* @mtime: a #GTimeVal.
*
/* Call this function after modifying a matcher.
* It will ensure all the invariants other functions rely on.
*/
-static void
+static GFileAttributeMatcher *
matcher_optimize (GFileAttributeMatcher *matcher)
{
SubMatcher *submatcher, *compare;
return matcher;
}
+ if (matcher->sub_matchers->len == 0)
+ {
+ g_file_attribute_matcher_unref (matcher);
+ return NULL;
+ }
+
/* sort sub_matchers by id (and then mask), so we can bsearch
* and compare matchers in O(N) instead of O(N²) */
g_array_sort (matcher->sub_matchers, compare_sub_matchers);
}
g_array_set_size (matcher->sub_matchers, j + 1);
+
+ return matcher;
}
/**
* @attributes: an attribute string to match.
*
* Creates a new file attribute matcher, which matches attributes
- * against a given string. #GFileAttributeMatcher<!-- -->s are reference
+ * against a given string. #GFileAttributeMatchers are reference
* counted structures, and are created with a reference count of 1. If
* the number of references falls to 0, the #GFileAttributeMatcher is
* automatically destroyed.
* The wildcard "*" may be used to match all keys and namespaces, or
* "namespace::*" will match all keys in a given namespace.
*
- * Examples of strings to use:
- * <table>
- * <title>File Attribute Matcher strings and results</title>
- * <tgroup cols='2' align='left'><thead>
- * <row><entry> Matcher String </entry><entry> Matches </entry></row></thead>
- * <tbody>
- * <row><entry>"*"</entry><entry>matches all attributes.</entry></row>
- * <row><entry>"standard::is-hidden"</entry><entry>matches only the key is-hidden in the standard namespace.</entry></row>
- * <row><entry>"standard::type,unix::*"</entry><entry>matches the type key in the standard namespace and
- * all keys in the unix namespace.</entry></row>
- * </tbody></tgroup>
- * </table>
+ * ## Examples of file attribute matcher strings and results
*
- * Returns: a #GFileAttributeMatcher.
- **/
+ * - `"*"`: matches all attributes.
+ * - `"standard::is-hidden"`: matches only the key is-hidden in the
+ * standard namespace.
+ * - `"standard::type,unix::*"`: matches the type key in the standard
+ * namespace and all keys in the unix namespace.
+ *
+ * Returns: a #GFileAttributeMatcher
+ */
GFileAttributeMatcher *
g_file_attribute_matcher_new (const char *attributes)
{
g_strfreev (split);
- matcher_optimize (matcher);
+ matcher = matcher_optimize (matcher);
return matcher;
}
/**
+ * g_file_attribute_matcher_subtract:
+ * @matcher: Matcher to subtract from
+ * @subtract: The matcher to subtract
+ *
+ * Subtracts all attributes of @subtract from @matcher and returns
+ * a matcher that supports those attributes.
+ *
+ * Note that currently it is not possible to remove a single
+ * attribute when the @matcher matches the whole namespace - or remove
+ * a namespace or attribute when the matcher matches everything. This
+ * is a limitation of the current implementation, but may be fixed
+ * in the future.
+ *
+ * Returns: A file attribute matcher matching all attributes of
+ * @matcher that are not matched by @subtract
+ **/
+GFileAttributeMatcher *
+g_file_attribute_matcher_subtract (GFileAttributeMatcher *matcher,
+ GFileAttributeMatcher *subtract)
+{
+ GFileAttributeMatcher *result;
+ guint mi, si;
+ SubMatcher *msub, *ssub;
+
+ if (matcher == NULL)
+ return NULL;
+ if (subtract == NULL)
+ return g_file_attribute_matcher_ref (matcher);
+ if (subtract->all)
+ return NULL;
+ if (matcher->all)
+ return g_file_attribute_matcher_ref (matcher);
+
+ result = g_malloc0 (sizeof (GFileAttributeMatcher));
+ result->ref = 1;
+ result->sub_matchers = g_array_new (FALSE, FALSE, sizeof (SubMatcher));
+
+ si = 0;
+ g_assert (subtract->sub_matchers->len > 0);
+ ssub = &g_array_index (subtract->sub_matchers, SubMatcher, si);
+
+ for (mi = 0; mi < matcher->sub_matchers->len; mi++)
+ {
+ msub = &g_array_index (matcher->sub_matchers, SubMatcher, mi);
+
+retry:
+ if (sub_matcher_matches (ssub, msub))
+ continue;
+
+ si++;
+ if (si >= subtract->sub_matchers->len)
+ break;
+
+ ssub = &g_array_index (subtract->sub_matchers, SubMatcher, si);
+ if (ssub->id <= msub->id)
+ goto retry;
+
+ g_array_append_val (result->sub_matchers, *msub);
+ }
+
+ if (mi < matcher->sub_matchers->len)
+ g_array_append_vals (result->sub_matchers,
+ &g_array_index (matcher->sub_matchers, SubMatcher, mi),
+ matcher->sub_matchers->len - mi);
+
+ result = matcher_optimize (result);
+
+ return result;
+}
+
+/**
* g_file_attribute_matcher_ref:
* @matcher: a #GFileAttributeMatcher.
*
return get_attribute_for_id (sub_matcher->id);
}
}
+
+/**
+ * g_file_attribute_matcher_to_string:
+ * @matcher: (allow-none): a #GFileAttributeMatcher.
+ *
+ * Prints what the matcher is matching against. The format will be
+ * equal to the format passed to g_file_attribute_matcher_new().
+ * The output however, might not be identical, as the matcher may
+ * decide to use a different order or omit needless parts.
+ *
+ * Returns: a string describing the attributes the matcher matches
+ * against or %NULL if @matcher was %NULL.
+ *
+ * Since: 2.32
+ **/
+char *
+g_file_attribute_matcher_to_string (GFileAttributeMatcher *matcher)
+{
+ GString *string;
+ guint i;
+
+ if (matcher == NULL)
+ return NULL;
+
+ if (matcher->all)
+ return g_strdup ("*");
+
+ string = g_string_new ("");
+ for (i = 0; i < matcher->sub_matchers->len; i++)
+ {
+ SubMatcher *submatcher = &g_array_index (matcher->sub_matchers, SubMatcher, i);
+
+ if (i > 0)
+ g_string_append_c (string, ',');
+
+ g_string_append (string, get_attribute_for_id (submatcher->id));
+ }
+
+ return g_string_free (string, FALSE);
+}
projects / platform / upstream / glib.git / blobdiff