Glib::BookmarkFile(3)

📦

version 1.3294 · 14 versions

1.3294 · opensuse-leap 16.0 (latest)
1.3293 · epel 9
1.3294 · epel 10
1.3294 · alpine 3.24
1.329.4 · arch rolling
1.329.4 · ubuntu stonking
1.329.3 · ubuntu questing
1.3294 · fedora 43
1.329.3 · ubuntu jammy
1.3294 · fedora 44
1.329.3 · ubuntu noble
1.329.3 · debian bookworm
1.329.4 · ubuntu resolute
1.329.3 · debian trixie

🦋 Glib::BookmarkFile(3) 🦋

okay so this is part 1 of the Glib::BookmarkFile(3) page from the User Contributed Perl Documentation, and it's giving parser-for-bookmark-files excellence. iykyk 💅

🌸 NAME 🌸

Glib::BookmarkFile — a parser for bookmark files. periodt. 🎀

✨ SYNOPSIS ✨

bestie, this synopsis is doing the most and honestly? slay. copy it exactly:

use Glib;

$date .= $_ while (<DATA>);

$b = Glib::BookmarkFile->new;
$b->load_from_data($data);
$uri = 'file:///some/path/to/a/file.txt';
if ($b->has_item($uri)) {
      $title = $b->get_title($uri);
      $desc  = $b->get_description($uri);

      print "Bookmark for `$uri' ($title):\n";
      print "  $desc\n";
}
0;

__DATA__
<?xml version="1.0" encoding="UTF-8"?>
<xbel version="1.0"
      xmlns:bookmark="http://www.freedesktop.org/standards/desktop-bookmarks"
      xmlns:mime="http://www.freedesktop.org/standards/shared-mime-info">
  <bookmark href="file:///tmp/test-file.txt" added="2006-03-22T18:54:00Z" modified="2006-03-22T18:54:00Z" visited="2006-03-22T18:54:00Z">
    <title>Test File</title>
    <desc>Some test file</desc>
    <info>
      <metadata owner="http://freedesktop.org">
        <mime:mime-type type="text/plain"/>
        <bookmark:applications>
          <bookmark:application name="Gedit" exec="gedit %u" timestamp="1143053640" count="1"/>
        </bookmark:applications>
      </metadata>
    </info>
  </bookmark>
</xbel>

💅 DESCRIPTION 💅

okay so Glib::BookmarkFile lets you parse, edit or create files containing lists of bookmarks to resources pointed to by URIs, with some meta-data bound to them, following the Desktop Bookmark Specification. the recent files support inside GTK+ uses this type of files to store the list of recently used files. 🫶

The syntax of bookmark files is described in detail in the Desktop Bookmarks Specification. here's the quick summary, bestie: bookmark files use a subclass of the XML Bookmark Exchange Language (XBEL) document format, defining meta-data such as the MIME type of the resource pointed by a bookmark, the list of applications that have registered the same URI and the visibility of the bookmark. 💖✨

✨ METHODS ✨

Okay bestie, this is the method buffet. Every bookmark inside a Glib::BookmarkFile is doing main character stuff, and these are the calls that make it happen. 💅

🎀 `bookmarkfile = Glib::BookmarkFile->new` 🎀

Fresh new Glib::BookmarkFile, ready for business. No extra args listed. Slay. ✨

🎀 `$bookmark_file->add_application ($uri, $name, $exec)` 🎀

$uri (string) — the bookmark URI.
$name (string or undef) — the app name, or undef for the default.
$exec (string or undef) — the launch command, or undef for the default.

Adds the application with $name and $exec to the list of applications that have registered a bookmark for $uri into $bookmark_file.

Every bookmark inside a Glib::BookmarkFile must have at least an application registered. Each application must provide a name, a command line useful for launching the bookmark, the number of times the bookmark has been registered by the application and the last time the application registered this bookmark.

If $name is undef, the name of the application will be the same returned by Glib::get_application_name(); if $exec is undef, the command line will be a composition of the program name as returned by Glib::get_prgname() and the "%u" modifier, which will be expanded to the bookmark's URI.

This function will automatically take care of updating the registrations count and timestamping in case an application with the same $name had already registered a bookmark for $uri inside the bookmark file. If no bookmark for $uri is found one is created. 🫶

🎀 `$bookmark_file->add_group ($uri, $group)` 🎀

$uri (string) — the bookmark URI.
$group (string) — the group name to add.

Adds $group to the list of groups to which the bookmark for $uri belongs to. If no bookmark for $uri is found one is created. 💖

🎀 `unix timestamp = $bookmark_file->get_added ($uri)` 🎀

$uri (string) — the bookmark URI.

No extra prose on this one — it gives you the added timestamp. ⏰

🎀 `$bookmark_file->set_added ($uri, $value)` 🎀

$uri (string) — the bookmark URI.
$value (unix timestamp) — the time to set.

Sets the time the bookmark for $uri was added. If no bookmark for $uri is found one is created. ✨

🎀 `($exec, $count, $stamp) = $bookmark_file->get_app_info ($uri, $name)` 🎀

$uri (string) — the bookmark URI.
$name (string) — the application name.

Gets the registration information of $name for the bookmark for $uri. See Glib::BookmarkFile::set_app_info() for more information about the returned data.

🎀 `$bookmark_file->set_app_info ($uri, $name, $exec, $count, $stamp)` 🎀

$uri (string) — the bookmark URI.
$name (string) — the application name.
$exec (string) — the launch command.
$count (integer) — the registration count.
$stamp (unix timestamp) — the last registration time.

Sets the meta-data of application $name inside the list of applications that have registered a bookmark for $uri inside $bookmark_file.

You should rarely use this method; use Glib::BookmarkFile::add_application() and Glib::BookmarkFile::remove_application() instead.

$name can be any UTF-8 encoded string used to identify an application. $exec can have one of these two modifiers: "%f", which will be expanded as the local file name retrieved from the bookmark's URI; "%u", which will be expanded as the bookmark's URI. The expansion is done automatically when retrieving the stored command line using the Glib::BookmarkFile::get_app_info() method. $count is the number of times the application has registered the bookmark; if it is < 0, the current registration count will be increased by one, if it is 0, the application with $name will be removed from the list of registered applications. $stamp is the Unix time of the last registration, as returned by time(); if it is -1, the current time will be used.

If you try to remove an application by setting its registration count to zero, and no bookmark for $uri is found, %FALSE is returned and an exception is fired. 💀

🎀 `list = $bookmark_file->get_applications ($uri)` 🎀

$uri (string) — the bookmark URI.

Retrieves the names of the applications that have registered the bookmark for $uri.

🎀 `$bookmark_file->get_description ($uri)` 🎀

$uri (string) — the bookmark URI.

Gets the description of the bookmark for $uri.

🎀 `$bookmark_file->set_description ($uri, $description)` 🎀

$uri (string) — the bookmark URI.
$description (string) — the description text.

Sets the description of the bookmark for $uri. If no bookmark for $uri is found one is created. 🌸

🎀 `list = $bookmark_file->get_groups ($uri)` 🎀

$uri (string) — the bookmark URI.

Retrieves the list of group names of the bookmark for $uri.

🎀 `$bookmark_file->set_groups ($uri, ...)` 🎀

$uri (string) — the bookmark URI.
... (list) — one or more group names.

Sets a list of group names for the item with URI $uri. Each previously set group name list is removed. If no bookmark for $uri is found one is created. 🎀

🎀 `boolean = $bookmark_file->has_application ($uri, $name)` 🎀

$uri (string) — the bookmark URI.
$name (string) — the application name.

Checks whether the bookmark for $uri inside $bookmark_file has been registered by application $name.

🎀 `boolean = $bookmark_file->has_group ($uri, $group)` 🎀

$uri (string) — the bookmark URI.
$group (string) — the group name.

Checks whether $group appears in the list of groups to which the bookmark for $uri belongs to.

🎀 `boolean = $bookmark_file->has_item ($uri)` 🎀

$uri (string) — the bookmark URI.

Looks whether the bookmark file has a bookmark for $uri. 👀

🎀 `($href, $mime_type) = $bookmark_file->get_icon ($uri)` 🎀

$uri (string) — the bookmark URI.

Gets the icon of the bookmark for $uri.

🎀 `$bookmark_file->set_icon ($uri, $href, $mime_type)` 🎀

$uri (string) — the bookmark URI.
$href (string or undef) — the icon href, or undef.
$mime_type (string or undef) — the icon MIME type, or undef.

Sets the icon for the bookmark for $uri. If $href is undef, unsets the currently set icon. 🖼️

🎀 `boolean = $bookmark_file->get_is_private ($uri)` 🎀

$uri (string) — the bookmark URI.

🎀 `$bookmark_file->set_is_private ($uri, $is_private)` 🎀

$uri (string) — the bookmark URI.
$is_private (boolean) — private or not.

No extra prose — just sets the private flag. 🙈

🎀 `$bookmark_file->load_from_data ($buf)` 🎀

$buf (scalar) — the bookmark file data.

Parses a string containing a bookmark file structure.

🎀 `($full_path) = $bookmark_file->load_from_data_dirs ($file)` 🎀

$file (localized file name) — the file to find.

Parses a bookmark file, searching for it inside the data directories. If a file is found, it returns the full path.

🎀 `$bookmark_file->load_from_file ($file)` 🎀

$file (localized file name) — the file to parse.

Parses a bookmark file.

🎀 `string = $bookmark_file->get_mime_type ($uri)` 🎀

$uri (string) — the bookmark URI.

Gets the MIME type of the bookmark for $uri.

🎀 `$bookmark_file->set_mime_type ($uri, $mime_type)` 🎀

$uri (string) — the bookmark URI.
$mime_type (string) — the MIME type.

Sets the MIME type of the bookmark for $uri. If no bookmark for $uri is found one is created. 🧚

🎀 `unix timestamp = $bookmark_file->get_modified ($uri)` 🎀

$uri (string) — the bookmark URI.

No extra prose — it gives you the modified timestamp. ⏳

🎀 `$bookmark_file->set_modified ($uri, $value)` 🎀

$uri (string) — the bookmark URI.
$value (unix timestamp) — the time to set.

Sets the time the bookmark for $uri was last modified. If no bookmark for $uri is found one is created. ✨

🎀 `$bookmark_file->move_item ($old_uri, $new_uri)` 🎀

$old_uri (string) — the current URI.
$new_uri (string or undef) — the new URI, or undef.

Changes the URI of a bookmark item from $old_uri to $new_uri. Any existing bookmark for $new_uri will be overwritten. If $new_uri is undef, then the bookmark is removed. 💅

🎀 `$bookmark_file->remove_application ($uri, $name)` 🎀

$uri (string) — the bookmark URI.
$name (string) — the application name.

Removes application registered with $name from the list of applications that have registered a bookmark for $uri inside $bookmark_file.

🎀 `$bookmark_file->remove_group ($uri, $group)` 🎀

$uri (string) — the bookmark URI.
$group (string) — the group name.

Removes $group from the list of groups to which the bookmark for $uri belongs to.

🎀 `$bookmark_file->remove_item ($uri)` 🎀

$uri (string) — the bookmark URI.

Removes the bookmark for $uri from the bookmark file.

🎀 `integer = $bookmark_file->get_size` 🎀

Gets the number of bookmarks inside the bookmark file. No args, just count vibes. 🔢

🎀 `$bookmark_file->get_title ($uri, $title)` 🎀

$uri (string) — the bookmark URI.

Gets the title of the bookmark for $uri.

🎀 `$bookmark_file->set_title ($uri, $title)` 🎀

$uri (string) — the bookmark URI.
$title (string) — the title text.

Sets the title of the bookmark for $uri. If no bookmark for $uri is found one is created. 👑

🎀 `string = $bookmark_file->to_data` 🎀

Returns the bookmark file as a string.

🎀 `$bookmark_file->to_file ($file)` 🎀

$file (localized file name) — where to save it.

Saves the contents of a bookmark file into a file. The write operation is guaranteed to be atomic by writing the contents of the bookmark file to a temporary file and then moving the file to the target file.

🎀 `list = $bookmark_file->get_uris` 🎀

Returns the URI of all the bookmarks in the bookmark file. All the URIs, all the vibes. 🌈

🎀 `unix timestamp = $bookmark_file->get_visited ($uri)` 🎀

$uri (string) — the bookmark URI.

No extra prose — it gives you the visited timestamp. ⏱️

🎀 `$bookmark_file->set_visited ($uri, $value)` 🎀

$uri (string) — the bookmark URI.
$value (unix timestamp) — the time to set.

Sets the time the bookmark for $uri was last visited. If no bookmark for $uri is found one is created. 💜

👀 SEE ALSO 👀

Glib — that's the whole SEE ALSO, bestie. Go read it. 🫶

🎀 COPYRIGHT 🎀

This software is licensed under the LGPL. See Glib for a full notice.

And that's the whole vibe check, bestie. This page is from perl v5.42.0, dated 2023-09-05 — kiss it goodbye, mwah. 🫶💖

📦 where this page comes from

opensuse-leap 16.0: perl-Glib 1.3294-160000.2.2 · LGPL-2.1-or-later
opensuse-leap 16.0: perl-Glib 1.3294-160000.2.2 · LGPL-2.1-or-later
opensuse-leap 16.0: perl-Glib 1.3294-160000.2.2 · LGPL-2.1-or-later
opensuse-leap 16.0: perl-Glib 1.3294-160000.2.2 · LGPL-2.1-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms

Glib::BookmarkFile(3)

🦋 Glib::BookmarkFile(3) 🦋

🌸 NAME 🌸

✨ SYNOPSIS ✨

💅 DESCRIPTION 💅

✨ METHODS ✨

🎀 bookmarkfile = Glib::BookmarkFile->new 🎀

🎀 $bookmark_file->add_application ($uri, $name, $exec) 🎀

🎀 $bookmark_file->add_group ($uri, $group) 🎀

🎀 unix timestamp = $bookmark_file->get_added ($uri) 🎀

🎀 $bookmark_file->set_added ($uri, $value) 🎀

🎀 ($exec, $count, $stamp) = $bookmark_file->get_app_info ($uri, $name) 🎀

🎀 $bookmark_file->set_app_info ($uri, $name, $exec, $count, $stamp) 🎀

🎀 list = $bookmark_file->get_applications ($uri) 🎀

🎀 $bookmark_file->get_description ($uri) 🎀

🎀 $bookmark_file->set_description ($uri, $description) 🎀

🎀 list = $bookmark_file->get_groups ($uri) 🎀

🎀 $bookmark_file->set_groups ($uri, ...) 🎀

🎀 boolean = $bookmark_file->has_application ($uri, $name) 🎀

🎀 boolean = $bookmark_file->has_group ($uri, $group) 🎀

🎀 boolean = $bookmark_file->has_item ($uri) 🎀

🎀 ($href, $mime_type) = $bookmark_file->get_icon ($uri) 🎀

🎀 $bookmark_file->set_icon ($uri, $href, $mime_type) 🎀

🎀 boolean = $bookmark_file->get_is_private ($uri) 🎀

🎀 $bookmark_file->set_is_private ($uri, $is_private) 🎀

🎀 $bookmark_file->load_from_data ($buf) 🎀

🎀 ($full_path) = $bookmark_file->load_from_data_dirs ($file) 🎀

🎀 $bookmark_file->load_from_file ($file) 🎀

🎀 string = $bookmark_file->get_mime_type ($uri) 🎀

🎀 $bookmark_file->set_mime_type ($uri, $mime_type) 🎀

🎀 unix timestamp = $bookmark_file->get_modified ($uri) 🎀

🎀 $bookmark_file->set_modified ($uri, $value) 🎀

🎀 $bookmark_file->move_item ($old_uri, $new_uri) 🎀

🎀 $bookmark_file->remove_application ($uri, $name) 🎀

🎀 $bookmark_file->remove_group ($uri, $group) 🎀

🎀 $bookmark_file->remove_item ($uri) 🎀

🎀 integer = $bookmark_file->get_size 🎀

🎀 $bookmark_file->get_title ($uri, $title) 🎀

🎀 $bookmark_file->set_title ($uri, $title) 🎀

🎀 string = $bookmark_file->to_data 🎀

🎀 $bookmark_file->to_file ($file) 🎀

🎀 list = $bookmark_file->get_uris 🎀

🎀 unix timestamp = $bookmark_file->get_visited ($uri) 🎀

🎀 $bookmark_file->set_visited ($uri, $value) 🎀