risc-os-community / libezini

This is a RISC OS port of EzINI a small and easy to use ANSI C library implementing INI file reading and writing.

LibEzINI

This is a RISC OS port of EzINI a small and easy to use ANSI C library implementing INI file reading and writing. This library is intended to be easy to use and build upon. It is small in size, thus not as feature complete as other libraries, but should be sufficient to meet most requirements.

Build the lib

To build from the source just git clone this repo and then go to LibEzINI -> src directory.

Using GCC

To build these files with GNU make and gcc, simply double click on the file called MkGCC, before you do that make sure that your RISC OS device Filer has seen where your copy of !GCC is (usually in Apps.Development).

Using ROOL DDE

To build these files with ROOL DDE, simply click on the file called MkDDE, before you do that please make sure your RISC OS device Filer has executed the !SetPaths from DDE which should be placed in AcornC/C++ directory.

Using LibEzINI in your code

Have a look at the file called sample in src.c, it demonstrates the usage of LibEzINI functions.

(section, key, value) triples are stored in entry structures (ini_entry_t) and multiple entry structures may be linked together in an entry list (ini_entry_list_t).

Read an INI file by calling GetEntryFromFile until it returns 0.

Write an INI file by using AddEntryToList to build an entry list, then call MakeINIFile to make a file from the entry list. Call FreeList when you are done.

Feedback

Feedback is always welcome!

In case of problems

For any issue you may encounter please use the Issues option here on GitHub. You can find it at the top of the page. Please do not try to contact us directly, the RISC OS Community handles all the communications here on GitHub.

Requesting new features

As for the problems reporting please use the Issues option here on GitHub also to request new features.

Contributing

We welcome improvements and new ideas, before you submit your changes please have a look at the Contributing Guidelines here

Official EzINI Documentation

See https://michaeldipperstein.github.io/ezini/

License

The original EzINI is released under LGPLv3, so is LibEzINI port here.

Contributors

- The EzINI original author

- RISC OS Porting

libezini's Issues

Add test code that uses !ConfX generated INI files

Background

For this issue you simply need to add new tests that consume !ConfX generated INI files to ensure that LibEzINI can be used to process !ConfX generated configuration files.

Do not commit directly to the main branch, instead create your own branch or fork, add your changes and test them, then request for a PR to develop branch.

Multiple PRs are ok for this task. :)

Definition of Done

• Add new test code in Tests that compiles with both GCC and DDE
• Your added test code has to ingest and process correctly !ConfX generated INI files (you can pre-generate them and include them with your PR)
• Code should compile out of the box, no missing dependencies are allowed