summaryrefslogtreecommitdiff
path: root/cpp/README.md
blob: 9344934259f04df413cb4ad49907b59824df971e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# libpom++

C++ parser for the [POM configuration language](https://pom.computer).

Requires at least C++17.

## Building

See [C building instructions](../README.md) (C++ library will be built alongside it automatically by default).

## Basic usage

```c++
#include <pom.hpp>
#include <iostream>

int main(void) {
	try {
		pom::Configuration conf = pom::Configuration("conf.pom", nullptr);
		auto indentation_type = conf.get("indentation-type");
		if (indentation_type.has_value())
			std::cout << "Indenting with " << indentation_type.value() << "\n";
		else
			std::cout << "No indentation type set!\n";
	} catch (pom::Error &error) {
		// Parsing error!
		std::cerr << error << "\n";
	}
}
```

Assuming you have run `make install`, you just need to add `-l:libpom++.a -l:libpom.a` (or `-lpom++ -lpom` to
use the shared library) to your compiler flags.


See `examples/` directory for more examples.

## Contributing

Contributions are welcome, including bug fixes, examples, improvements
to documentation or code readability, and error message translations (see `../errors.c`).

## License

```text
Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
```