https://github.com/freeslave/inilike

D library for parsing .ini-like files used in Freedesktop systems
https://github.com/freeslave/inilike

d dlang freedesktop

Last synced: 3 months ago
JSON representation

D library for parsing .ini-like files used in Freedesktop systems

• Host: GitHub
• URL: https://github.com/freeslave/inilike
• Owner: FreeSlave
• License: bsl-1.0
• Created: 2015-05-31T18:59:43.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2022-11-19T00:21:11.000Z (over 3 years ago)
• Last Synced: 2025-07-21T11:45:39.941Z (10 months ago)
• Topics: d, dlang, freedesktop
• Language: D
• Homepage:
• Size: 170 KB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE_1_0.txt

Awesome Lists containing this project

README

          
# Inilike

Inilike is D library for parsing **.ini-like** files used in Freedesktop systems in various places (.desktop files, icon themes, mimeapps.list, mimeinfo.cache, trashcan files on freedesktop, etc.)

[![Build Status](https://github.com/FreeSlave/inilike/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/FreeSlave/inilike/actions/workflows/ci.yml) [![Coverage Status](https://coveralls.io/repos/FreeSlave/inilike/badge.svg?branch=master&service=github)](https://coveralls.io/github/FreeSlave/inilike?branch=master)

[Online documentation](https://freeslave.github.io/d-freedesktop/docs/inilike.html)

Note: the original purpose of this library is to serve as dependency for my other projects, e.g. [desktopfile](https://github.com/FreeSlave/desktopfile) and [icontheme](https://github.com/FreeSlave/icontheme). It may be not suitable to save configuration files using this library. You have been warned.

## Format

Freedesktop specifications use the format which is sometimes referred to as **.ini-like** because it's very similiar to **INI** used in MS Windows with small differences:

1. Comments start with '#', not ';'.

2. Each comment is always placed on its own line. Key-value can't be mixed with a comment on the same line.

Example:

    # Comment

    [Group name]

    Key=Value

    # Comment inside group

    AnotherKey=Value

    [Another group]

    Key=English value

    Key[fr_FR]=Francais value

## Localized values lookup

The localized value is the value associated with the localized key. Localized keys look like this:

    keyname[locale]

where **locale** is the [POSIX locale](http://en.wikipedia.org/wiki/Locale) with the charset part dropped.

Inilike library has support for lookup of localized values, using the algorithm described in [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s05.html).

## Subclassing IniLikeFile

IniLikeFile is the base class for file of ini-like format. To change its functionality (validation and other behavior) it needs to be subclassed. 

See [example](source/inilike/package.d) in unittests that shows which functions can be overridden.