The cl-xdg Reference Manual

3.1.1 cl-xdg/cl-xdg.asd

Source

cl-xdg.asd.

Parent Component

cl-xdg (system).

ASDF Systems

cl-xdg.

---

3.1.2 cl-xdg/package.lisp

Source

cl-xdg.asd.

Parent Component

cl-xdg (system).

Packages

• cl-xdg/sxml.
• cl-xdg.

---

3.1.3 cl-xdg/ordered-hash-table.lisp

Dependency

package.lisp (file).

Source

cl-xdg.asd.

Parent Component

cl-xdg (system).

Internals

• get-ordered-hash (function).
• (setf get-ordered-hash) (function).
• make-ordered-hash-table (function).
• map-ordered-hash (function).
• ordered-hash-table (class).
• rem-ordered-hash (function).

---

3.1.4 cl-xdg/desktop.lisp

Dependency

ordered-hash-table.lisp (file).

Source

cl-xdg.asd.

Parent Component

cl-xdg (system).

Public Interface

• desktop-file (class).
• desktop-files (class).
• find-desktop-file-by-id (function).
• get-boolean-key (function).
• get-locale-string-key (function).
• get-locale-strings-key (function).
• get-number-key (function).
• get-string-key (function).
• get-strings-key (function).
• id (reader method).
• load-desktop-file (function).
• load-desktop-files (function).
• path (reader method).

Internals

• lc-messages-to-locales (function).
• parse-desktop-file-line (function).
• parse-locale (function).
• replace-all (function).
• replace-escapes (function).
• split-multi-string (function).

---

3.1.5 cl-xdg/menus.lisp

Dependency

desktop.lisp (file).

Source

cl-xdg.asd.

Parent Component

cl-xdg (system).

Internals

• *menu-files-in-flight* (special variable).
• dont-resolve-entities (function).
• dtd-resolver (function).
• merge-dir (function).
• merge-file (function).
• merge-menus (function).
• merge-parent (function).
• merge-path (function).
• read-menu (function).

---

5.1.1 Ordinary functions

Function: find-desktop-file-by-id (files id) ¶

Find the desktop file with the given ID in FILES.

Package

cl-xdg.

Source

desktop.lisp.

Function: get-boolean-key (key file &key group) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: get-locale-string-key (key file &key group locales) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: get-locale-strings-key (key file &key group locales) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: get-number-key (key file &key group) ¶

PARSE-NUMBER:PARSE-NUMBER doesn’t _quite_ implement the semantics of strtod/sscanf, but it’s portable. The desktop file spec doesn’t define any standard number keys anyway.

Package

cl-xdg.

Source

desktop.lisp.

Function: get-string-key (key file &key group) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: get-strings-key (key file &key group) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: load-desktop-file (filespec) ¶

Load the desktop file found in FILESPEC into a DESKTOP-FILE object.

Package

cl-xdg.

Source

desktop.lisp.

Function: load-desktop-files (&optional subdir) ¶

Load desktop files from SUBDIR underneath $XDG_DATA_HOME and each of $XDG_DATA_DIRS. Desktop files found under #P"applications/" have IDs; files earlier in the search path take precedence over files later in the search path with the same ID.

Package

cl-xdg.

Source

desktop.lisp.

---

5.1.2 Generic functions

Generic Reader: id (object) ¶

Package

cl-xdg.

Methods

Reader Method: id ((desktop-file desktop-file)) ¶

automatically generated reader method

Source

desktop.lisp.

Target Slot

id.

Generic Reader: path (object) ¶

Package

cl-xdg.

Methods

Reader Method: path ((desktop-file desktop-file)) ¶

automatically generated reader method

Source

desktop.lisp.

Target Slot

path.

---

5.1.3 Classes

Class: desktop-file ¶

Package

cl-xdg.

Source

desktop.lisp.

Direct methods

• id.
• path.

Direct slots

Slot: hash ¶

Type

cl-xdg::ordered-hash-table

Initargs

:hash

Slot: id ¶

Type

string

Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: path ¶

Type

pathname

Initargs

:path

Readers

path.

Writers

This slot is read-only.

Class: desktop-files ¶

Package

cl-xdg.

Source

desktop.lisp.

Direct slots

Slot: files ¶

Type

hash-table

Initargs

:files

---

5.2.1 Special variables

Special Variable: *menu-files-in-flight* ¶

Package

cl-xdg.

Source

menus.lisp.

---

5.2.2 Ordinary functions

Function: dont-resolve-entities (a b) ¶

Package

cl-xdg.

Source

menus.lisp.

Function: dtd-resolver (public-id system-id) ¶

Package

cl-xdg.

Source

menus.lisp.

Function: get-ordered-hash (key hash-table &optional default) ¶

Package

cl-xdg.

Source

ordered-hash-table.lisp.

Function: (setf get-ordered-hash) (key hash-table) ¶

Package

cl-xdg.

Source

ordered-hash-table.lisp.

Function: lc-messages-to-locales () ¶

Convert LC_MESSAGES to a preference-ordered list of locales.

Package

cl-xdg.

Source

desktop.lisp.

Function: make-ordered-hash-table (&key test size rehash-size rehash-threshold) ¶

Package

cl-xdg.

Source

ordered-hash-table.lisp.

Function: map-ordered-hash (function hash-table) ¶

Package

cl-xdg.

Source

ordered-hash-table.lisp.

Function: merge-dir (path) ¶

Package

cl-xdg.

Source

menus.lisp.

Function: merge-file (element) ¶

Package

cl-xdg.

Source

menus.lisp.

Function: merge-menus (element) ¶

Process MergeFile, MergeDir and LegacyDir elements, and remove extraneous whitespace.

Package

cl-xdg.

Source

menus.lisp.

Function: merge-parent () ¶

Package

cl-xdg.

Source

menus.lisp.

Function: merge-path (path) ¶

Package

cl-xdg.

Source

menus.lisp.

Function: parse-desktop-file-line (line current-group) ¶

Given a line and the currently-active group, return a key and a value to store in the desktop file ordered hash. The possibilities are:

- comment: (GENSYM COMMENT)
- group: (GROUP NIL)
- key: ((GROUP KEY LOCALE) VALUE) or ((GROUP KEY) VALUE)

Package

cl-xdg.

Source

desktop.lisp.

Function: parse-locale (locale) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: read-menu (filespec) ¶

Package

cl-xdg.

Source

menus.lisp.

Function: rem-ordered-hash (key hash-table) ¶

Package

cl-xdg.

Source

ordered-hash-table.lisp.

Function: replace-all (string part replacement &key test) ¶

Returns a new string in which all the occurences of the part is replaced with replacement.

Package

cl-xdg.

Source

desktop.lisp.

Function: replace-escapes (str) ¶

Package

cl-xdg.

Source

desktop.lisp.

Function: split-multi-string (str) ¶

Package

cl-xdg.

Source

desktop.lisp.

---

5.2.3 Classes

Class: ordered-hash-table ¶

Package

cl-xdg.

Source

ordered-hash-table.lisp.

Direct slots

Slot: hash ¶

Type

hash-table

Initargs

:hash

Slot: keys ¶

Type

(vector t 1)

Initargs

:keys

---