yanglint FEATURE initial version of yanglint(1)

Source codes are mostly taken from libyang 1.0 and slightly modified for
libyang 2.0. A lot of functionality is still missing since it is not yet
provided by libyang 2.0

Author: rkrejci

CMakeLists.txt

@@ -185,20 +185,17 @@ set(libsrc
     src/xml.c
     src/xpath.c)
 
-#set(lintsrc
-#    tools/lint/main.c
-#    tools/lint/main_ni.c
-#    tools/lint/commands.c
-#    tools/lint/completion.c
-#    tools/lint/configuration.c
-#    linenoise/linenoise.c)
+set(lintsrc
+    tools/lint/main.c
+    tools/lint/main_ni.c
+    tools/lint/commands.c
+    tools/lint/completion.c
+    tools/lint/configuration.c
+    tools/lint/linenoise/linenoise.c)
 
 #set(resrc
 #    tools/re/main.c)
 
-#set(yang2yinsrc
-#    tools/yang2yin/main.c)
-
 set(headers
     src/libyang.h
     src/context.h
@@ -340,19 +337,21 @@ endif(ENABLE_BUILD_TESTS)
 #
 #configure_file(${PROJECT_SOURCE_DIR}/src/plugin_config.h.in ${PROJECT_BINARY_DIR}/src/plugin_config.h)
 
+# config file for tools
+configure_file(${PROJECT_SOURCE_DIR}/tools/config.h.in ${PROJECT_BINARY_DIR}/tools/config.h @ONLY)
+
 # yanglint
-#add_executable(yanglint ${lintsrc})
-#target_link_libraries(yanglint yang)
-#install(TARGETS yanglint DESTINATION ${CMAKE_INSTALL_BINDIR})
-#install(FILES ${PROJECT_SOURCE_DIR}/tools/lint/yanglint.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
+add_executable(yanglint ${lintsrc})
+target_link_libraries(yanglint yang)
+install(TARGETS yanglint DESTINATION ${CMAKE_INSTALL_BINDIR})
+install(FILES ${PROJECT_SOURCE_DIR}/tools/lint/yanglint.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
+target_include_directories(yanglint BEFORE PRIVATE ${PROJECT_BINARY_DIR}/tools)
 
 #yangre
 #add_executable(yangre ${resrc})
 #target_link_libraries(yangre yang)
 #install(TARGETS yangre DESTINATION ${CMAKE_INSTALL_BINDIR})
-
-# yang2yin
-#add_executable(yang2yin ${yang2yinsrc})
+#target_include_directories(yangre BEFORE PRIVATE ${PROJECT_BINARY_DIR}/tools)
 
 if(ENABLE_VALGRIND_TESTS)
     set(ENABLE_BUILD_TESTS ON)

src/context.c

@@ -153,6 +153,36 @@ ly_ctx_unset_searchdirs(struct ly_ctx *ctx, const char *value)
     return LY_SUCCESS;
 }
 
+API LY_ERR
+ly_ctx_unset_searchdir(struct ly_ctx *ctx, unsigned int index)
+{
+    LY_CHECK_ARG_RET(ctx, ctx, LY_EINVAL);
+
+    if (!ctx->search_paths.count) {
+        return LY_SUCCESS;
+    }
+
+    if (index >= ctx->search_paths.count) {
+        LOGARG(ctx, value);
+        return LY_EINVAL;
+    } else {
+        return ly_set_rm_index(&ctx->search_paths, index, free);
+    }
+
+    return LY_SUCCESS;
+}
+
+API const struct lys_module *
+ly_ctx_load_module(struct ly_ctx *ctx, const char *name, const char *revision)
+{
+    struct lys_module *result = NULL;
+
+    LY_CHECK_ARG_RET(ctx, ctx, name, NULL);
+
+    LY_CHECK_RET(lysp_load_module(ctx, name, revision, 1, 0, &result), NULL);
+    return result;
+}
+
 API LY_ERR
 ly_ctx_new(const char *search_dir, int options, struct ly_ctx **new_ctx)
 {
@@ -163,6 +193,8 @@ ly_ctx_new(const char *search_dir, int options, struct ly_ctx **new_ctx)
     int i;
     LY_ERR rc = LY_SUCCESS;
 
+    LY_CHECK_ARG_RET(NULL, new_ctx, LY_EINVAL);
+
     ctx = calloc(1, sizeof *ctx);
     LY_CHECK_ERR_RET(!ctx, LOGMEM(NULL), LY_EMEM);
 
@@ -280,6 +312,18 @@ ly_ctx_get_module_imp_clb(const struct ly_ctx *ctx, void **user_data)
     return ctx->imp_clb;
 }
 
+API const struct lys_module *
+ly_ctx_get_module_iter(const struct ly_ctx *ctx, unsigned int *index)
+{
+    LY_CHECK_ARG_RET(ctx, ctx, index, NULL);
+
+    for ( ; *index < (unsigned)ctx->list.count; (*index)++) {
+        return ctx->list.objs[(*index)++];
+    }
+
+    return NULL;
+}
+
 /**
  * @brief Iterate over the modules in the given context. Returned modules must match the given key at the offset of
  * lysp_module and lysc_module structures (they are supposed to be placed at the same offset in both structures).

src/context.h

@@ -104,12 +104,25 @@ LY_ERR ly_ctx_set_searchdir(struct ly_ctx *ctx, const char *search_dir);
 /**
  * @brief Clean the search path(s) from the libyang context
  *
+ * To remove the search path by its index, use ly_ctx_unset_searchdir().
+ *
  * @param[in] ctx Context to be modified.
  * @param[in] value Searchdir to be removed, use NULL to remove them all.
  * @return LY_ERR return value
  */
 LY_ERR ly_ctx_unset_searchdirs(struct ly_ctx *ctx, const char *value);
 
+/**
+ * @brief Remove the specific search path from the libyang context.
+ *
+ * To remove the search path by its value, use ly_ctx_unset_searchdirs().
+ *
+ * @param[in] ctx Context to be modified.
+ * @param[in] index Index of the searchdir to be removed.
+ * @return LY_ERR return value
+ */
+LY_ERR ly_ctx_unset_searchdir(struct ly_ctx *ctx, unsigned int index);
+
 /**
  * @brief Get the NULL-terminated list of the search paths in libyang context. Do not modify the result!
  *
@@ -231,6 +244,25 @@ struct lys_module *ly_ctx_get_module_latest(const struct ly_ctx *ctx, const char
  */
 struct lys_module *ly_ctx_get_module_implemented(const struct ly_ctx *ctx, const char *name);
 
+/**
+ * @brief Get the (only) implemented YANG module specified by its name.
+ *
+ * @param[in] ctx Context where to search.
+ * @param[in] name Name of the YANG module to get.
+ * @return The only implemented YANG module revision of the given name in the given context. NULL if there is no
+ * implemented module of the given name.
+ */
+/**
+ * @brief Iterate over all modules in the given context.
+ *
+ * @param[in] ctx Context with the modules.
+ * @param[in,out] index Index of the next module to get. Value of 0 starts from the beginning.
+ * The value is updated with each call, so to iterate over all modules the same variable is supposed
+ * to be used in all calls starting with value 0.
+ * @return Next context module, NULL if the last was already returned.
+ */
+const struct lys_module *ly_ctx_get_module_iter(const struct ly_ctx *ctx, unsigned int *index);
+
 /**
  * @brief Get YANG module of the given namespace and revision.
  *
@@ -292,6 +324,23 @@ void ly_ctx_reset_latests(struct ly_ctx *ctx);
  */
 LY_ERR ly_ctx_module_implement(struct ly_ctx *ctx, struct lys_module *mod);
 
+/**
+ * @brief Try to find the model in the searchpaths of \p ctx and load it into it. If custom missing
+ * module callback is set, it is used instead.
+ *
+ * The context itself is searched for the requested module first. If \p revision is not specified
+ * (the module of the latest revision is requested) and there is implemented revision of the requested
+ * module in the context, this implemented revision is returned despite there might be a newer revision.
+ * This behavior is cause by the fact that it is not possible to have multiple implemented revisions of
+ * the same module in the context.
+ *
+ * @param[in] ctx Context to add to.
+ * @param[in] name Name of the module to load.
+ * @param[in] revision Optional revision date of the module. If not specified, the latest revision is loaded.
+ * @return Pointer to the data model structure, NULL if not found or some error occurred.
+ */
+const struct lys_module *ly_ctx_load_module(struct ly_ctx *ctx, const char *name, const char *revision);
+
 /**
  * @brief Free all internal structures of the specified context.
  *

src/tree_schema.c

@@ -427,19 +427,19 @@ lys_feature_change(const struct lys_module *mod, const char *name, int value)
 }
 
 API LY_ERR
-lys_feature_enable(struct lys_module *module, const char *feature)
+lys_feature_enable(const struct lys_module *module, const char *feature)
 {
     LY_CHECK_ARG_RET(NULL, module, feature, LY_EINVAL);
 
-    return lys_feature_change(module, feature, 1);
+    return lys_feature_change((struct lys_module*)module, feature, 1);
 }
 
 API LY_ERR
-lys_feature_disable(struct lys_module *module, const char *feature)
+lys_feature_disable(const struct lys_module *module, const char *feature)
 {
     LY_CHECK_ARG_RET(NULL, module, feature, LY_EINVAL);
 
-    return lys_feature_change(module, feature, 0);
+    return lys_feature_change((struct lys_module*)module, feature, 0);
 }
 
 API int
@@ -517,11 +517,11 @@ lys_parse_mem_submodule(struct ly_ctx *ctx, const char *data, LYS_INFORMAT forma
     memcpy(&context.grps_nodes, &main_ctx->grps_nodes, sizeof main_ctx->grps_nodes);
 
     switch (format) {
+    /* TODO not yet supported
     case LYS_IN_YIN:
-        /* TODO not yet supported
         mod = yin_read_module();
-        */
         break;
+    */
     case LYS_IN_YANG:
         ret = yang_parse_submodule(&context, data, &submod);
         break;
@@ -589,11 +589,11 @@ lys_parse_mem_module(struct ly_ctx *ctx, const char *data, LYS_INFORMAT format,
     mod->ctx = ctx;
 
     switch (format) {
+    /* TODO not yet supported
     case LYS_IN_YIN:
-        /* TODO not yet supported
         mod = yin_read_module();
-        */
         break;
+    */
     case LYS_IN_YANG:
         ret = yang_parse_module(&context, data, mod);
         break;
@@ -1004,10 +1004,12 @@ lys_search_localfile(const char * const *searchpaths, int cwd, const char *name,
 
                 /* get type according to filename suffix */
                 flen = strlen(file->d_name);
-                if (!strcmp(&file->d_name[flen - 4], ".yin")) {
-                    format_aux = LYS_IN_YIN;
-                } else if (!strcmp(&file->d_name[flen - 5], ".yang")) {
+                if (!strcmp(&file->d_name[flen - 5], ".yang")) {
                     format_aux = LYS_IN_YANG;
+                /* TODO YIN parser
+                } else if (!strcmp(&file->d_name[flen - 4], ".yin")) {
+                    format_aux = LYS_IN_YIN;
+                */
                 } else {
                     /* not supportde suffix/file format */
                     continue;

src/tree_schema.h

@@ -1595,7 +1595,7 @@ struct lys_module {
  * @param[in] feature Name of the feature to enable. To enable all features at once, use asterisk (`*`) character.
  * @return LY_ERR value.
  */
-LY_ERR lys_feature_enable(struct lys_module *module, const char *feature);
+LY_ERR lys_feature_enable(const struct lys_module *module, const char *feature);
 
 /**
  * @brief Disable specified feature in the module
@@ -1606,7 +1606,7 @@ LY_ERR lys_feature_enable(struct lys_module *module, const char *feature);
  * @param[in] feature Name of the feature to disable. To disable all features at once, use asterisk (`*`) character.
  * @return LY_ERR value
  */
-LY_ERR lys_feature_disable(struct lys_module *module, const char *feature);
+LY_ERR lys_feature_disable(const struct lys_module *module, const char *feature);
 
 /**
  * @brief Get the current status of the specified feature in the module.

src/tree_schema_helpers.c

@@ -747,8 +747,18 @@ lysp_load_module(struct ly_ctx *ctx, const char *name, const char *revision, int
     if (!*mod) {
         /* try to get the module from the context */
         if (revision) {
+            /* get the specific revision */
             *mod = (struct lys_module*)ly_ctx_get_module(ctx, name, revision);
+        } else if (implement) {
+            /* prefer the implemented module instead of the latest one */
+            *mod = (struct lys_module*)ly_ctx_get_module_implemented(ctx, name);
+            if (!*mod) {
+                /* there is no implemented module in the context, try to get the latest revision module */
+                goto latest_in_the_context;
+            }
         } else {
+            /* get the requested module of the latest revision in the context */
+latest_in_the_context:
             *mod = (struct lys_module*)ly_ctx_get_module_latest(ctx, name);
         }
     }

src/tree_schema_internal.h

@@ -129,7 +129,9 @@ LY_ERR lysp_type_find(const char *id, struct lysp_node *start_node, struct lysp_
  * @param[in] ctx libyang context.
  * @param[in] name Name of the module to load.
  * @param[in] revison Optional revision of the module to load. If NULL, the newest revision is loaded.
- * @param[in] implement Flag if the loaded module is supposed to be marked as implemented.
+ * @param[in] implement Flag if the loaded module is supposed to be marked as implemented. If revision is NULL and implement flag set,
+ * the implemented module in the context is returned despite it might not be of the latest revision, because in this case the module
+ * of the latest revision can not be made implemented.
  * @param[in] require_parsed Flag to require parsed module structure in case the module is already in the context,
  * but only the compiled structure is available.
  * @param[out] mod Parsed module structure.

tools/config.h.in

@@ -0,0 +1,23 @@
+/**
+ * @file config.h
+ * @author Radek Krejci <[email protected]>
+ * @brief various variables detected by cmake
+ *
+ * Copyright (c) 2019 CESNET, z.s.p.o.
+ *
+ * This source code is licensed under BSD 3-Clause License (the "License").
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://opensource.org/licenses/BSD-3-Clause
+ */
+
+#ifndef YANGLINT_CONFIG_H_
+#define YANGLINT_CONFIG_H_
+
+#define _DEFAULT_SOURCE
+#define _GNU_SOURCE
+
+#define PROJECT_VERSION "@LIBYANG_VERSION@" /**< libyang project version string */
+
+#endif /* YANGLINT_CONFIG_H_ */