blob: cc1283af7ee1b963ad38f762a7595fdf30a1d26e [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file libyang.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief The main libyang public header.
5 *
6 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_LIBYANG_H_
16#define LY_LIBYANG_H_
17
Radek Krejci0af5f5d2018-09-07 15:00:30 +020018#include <stdint.h>
19
Radek Krejci5aeea3a2018-09-05 13:29:36 +020020#ifdef __cplusplus
21extern "C" {
22#endif
23
Radek Krejci6caa6ab2018-10-24 10:04:48 +020024#include "log.h"
25#include "set.h"
26#include "dict.h"
27#include "context.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020028#include "tree.h"
29#include "tree_data.h"
Radek Krejci6caa6ab2018-10-24 10:04:48 +020030#include "tree_schema.h"
Radek Krejcid3ca0632019-04-16 16:54:54 +020031#include "printer_schema.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020032#include "printer_data.h"
Radek Krejci74a3e232019-07-16 10:46:05 +020033#include "plugins_types.h"
Radek Krejci6caa6ab2018-10-24 10:04:48 +020034
Radek Krejci5aeea3a2018-09-05 13:29:36 +020035/**
Radek Krejcie53a8dc2018-10-17 12:52:40 +020036 * @mainpage About
37 *
38 * libyang is a library implementing processing of the YANG schemas and data modeled by the YANG language. The
39 * library is implemented in C for GNU/Linux and provides C API.
40 *
41 * @section about-features Main Features
42 *
43 * - [Parsing (and validating) schemas](@ref howtoschemasparsers) in YANG format.
44 * - [Parsing (and validating) schemas](@ref howtoschemasparsers) in YIN format.
45 * - [Parsing, validating and printing instance data](@ref howtodata) in XML format.
46 * - [Parsing, validating and printing instance data](@ref howtodata) in JSON format
47 * ([RFC 7951](https://tools.ietf.org/html/rfc7951)).
48 * - [Manipulation with the instance data](@ref howtodatamanipulators).
49 * - Support for [default values in the instance data](@ref howtodatawd) ([RFC 6243](https://tools.ietf.org/html/rfc6243)).
50 * - Support for [YANG extensions and user types](@ref howtoschemaplugins).
51 * - Support for [YANG Metadata](@ref howtoschemametadata) ([RFC 7952](https://tools.ietf.org/html/rfc6243)).
52 *
53 * The current implementation covers YANG 1.0 ([RFC 6020](https://tools.ietf.org/html/rfc6020)) as well as
54 * YANG 1.1 ([RFC 7950](https://tools.ietf.org/html/rfc7950)).
55 *
56 * @section about-license License
57 *
58 * Copyright (c) 2015-2017 CESNET, z.s.p.o.
59 *
60 * (The BSD 3-Clause License)
61 *
62 * Redistribution and use in source and binary forms, with or without
63 * modification, are permitted provided that the following conditions
64 * are met:
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 * 3. Neither the name of the Company nor the names of its contributors
72 * may be used to endorse or promote products derived from this
73 * software without specific prior written permission.
74 */
75
76/**
77 * @page howto How To ...
78 *
79 * - @subpage howtocontext
80 * - @subpage howtoschemas
81 * - @subpage howtodata
82 * - @subpage howtoxpath
83 * - @subpage howtoxml
84 * - @subpage howtothreads
85 * - @subpage howtologger
86 * - @subpage howtostructures
87 */
88
89/**
90 * @page howtostructures Data Structures
91 *
92 * @section sizedarrays Sized Arrays
93 *
94 * The structure starts with 32bit number storing size of the array - the number of the items inside. The size is part of the
Radek Krejci2c4e7172018-10-19 15:56:26 +020095 * array to have it allocated together with the array itself only when it is needed. However, the pointers to the array always
96 * points after the 32b number, so items can be accessed directly as for standard C arrays. Because of a known size (available
97 * via ::LY_ARRAY_SIZE macro), it is not terminated by any special byte (sequence), so there is also no limitation for specific
98 * content of the stored records (e.g. that first byte must not be NULL).
Radek Krejcie53a8dc2018-10-17 12:52:40 +020099 *
Radek Krejci2c4e7172018-10-19 15:56:26 +0200100 * The sized arrays must be carefully freed (which should be done anyway only internally), since pointers to the sized arrays used
101 * in libyang structures, does not point to the beginning of the allocated space.
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200102 *
103 * - ::LY_ARRAY_SIZE
Radek Krejcie53a8dc2018-10-17 12:52:40 +0200104 * - ::LY_ARRAY_FOR
105 *
106 * @section struct_lists Lists
107 *
108 * The lists are structures connected via a `next` pointer. Iterating over the siblings can be simply done by ::LY_LIST_FOR macro.
109 */
110
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200111#ifdef __cplusplus
112}
113#endif
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200114
115#endif /* LY_LIBYANG_H_ */