Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://gitlab.com/wikiti-random-stuff/hxini
hxIni is a fast, light and simple library to read and write INI files, using hashes.
https://gitlab.com/wikiti-random-stuff/hxini
haxe ini lib library openfl
Last synced: 5 days ago
JSON representation
hxIni is a fast, light and simple library to read and write INI files, using hashes.
- Host: gitlab.com
- URL: https://gitlab.com/wikiti-random-stuff/hxini
- Owner: wikiti-random-stuff
- License: mit
- Created: 2014-07-30T12:53:33.356Z (over 10 years ago)
- Default Branch: master
- Last Synced: 2024-12-23T21:35:46.750Z (16 days ago)
- Topics: haxe, ini, lib, library, openfl
- Stars: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](LICENSE.md) [](http://lib.haxe.org/p/hxIni/) [](https://circleci.com/gh/wikiti/hxIni)
# hxIni
## Introduction
hxIni is a fast, light and simple library to read and write INI files, using hashes.
Checkout [wikipedia](http://en.wikipedia.org/wiki/INI_file) for more information about **INI Files**.
## Install
Use ***haxelib*** to install the release version of the library (if avaliable):
> haxelib install hxIni
Otherwise, you can download this repository as a zip from *GitHub* (you can try [this link](https://github.com/wikiti/hxIni/archive/master.zip)), and use the local installer from ***haxelib***:
> haxelib local hxIni-master.zip
Also, don't forget to add
to your **xml** project file, or, for a standard *Haxe* project, add
-l hxini
in your **hxml** build file.
## Usage
Let's explain this with an example. Imagine you have this **example.ini** file:
; - example.ini
; last modified 1 April 2001 by John Doe
[owner]
name=John Doe
organization=Acme Widgets Inc.
[database]
; use IP address in case network name resolution is not working
server=192.0.2.62
port=143
file="payroll.dat"
There we have two sections (*owner* and *database*), and each one has its own parameters ([*name*, *organization*] and [*server*, *port*, *file*]).
Now, to parse this with hxIni, we must create an **Ini** object with **IniManager** class:
var ini: Ini = IniManager.loadFromFile("example.ini");
Or, if you have that stored in a **String**, you can use:
var ini: Ini = IniManager.loadFromString(str_data);
And, the access to parameters it's pretty simple. Imagine a *map* of *maps*, so a section if linked to a *map* of parameters, and you can access like this:
var name = ini["owner"]["name"];
Finally, you can transform them to a string (after modifications), or save it to a file:
IniManager.writeToFile(ini, "test.ini");
trace( IniManager.toString(ini) );
Also, don't forget to **import** the classes!
import hxIni.IniManager;
import hxIni.IniManager.Ini;
## Parse rules
1. **Comments** (lines starting with `;`) and **white lines** will be **ignored**.
2. Every **parameter** must belong to at least **one section**.
3. If a **parameter** with an **used name** is found on the same section, it will be **replaced**.
4. If no section is declared, the **Global** section will be used by default (**IniManager.GLOBAL_SECTION**).
5. **UTF-8** is usable, but not recommend.
6. You can use **[Escaped characters](http://en.wikipedia.org/wiki/INI_file#Escape_characters)**.
7. Parameters **keys** and **values** are **case sensitive**.
## Development
Clone the repository:
```shell
$ git clone https://github.com/wikiti/hxini
```
Then, setup the development directory:
```shell
$ haxelib dev hxini hxini
```
To run tests use [munit](https://github.com/massiveinteractive/MassiveUnit):
```shell
$ haxelib install munit
$ haxelib run munit test
```
## Contributors
The following people have helped to develop this library:
| Avatar | Name | Nickname | Contact |
| ------- | ------------- | --------- | ------------------ |
|  | Daniel Herzog | Wikiti | [[email protected]](mailto:[email protected])
|  | Thomas ten Cate | ttencate | [GitHub Profile](https://github.com/ttencate)
## Links
- HaxeLib: [http://lib.haxe.org/p/hxIni](http://lib.haxe.org/p/hxIni)
- Wikipedia: [http://en.wikipedia.org/wiki/INI_file](http://en.wikipedia.org/wiki/INI_file)
- INI Parsing: [http://stackoverflow.com/questions/3870019/javascript-parser-for-a-string-which-contains-ini-data](http://stackoverflow.com/questions/3870019/javascript-parser-for-a-string-which-contains-ini-data)