printer data REFACTOR shorten printer flags

Author: michalvasko

src/out.c

@@ -56,7 +56,7 @@ lyd_node_should_print(const struct lyd_node *node, uint32_t options)
                 return 0;
             }
         } else if (lysc_is_np_cont(node->schema)) {
-            if (options & LYD_PRINT_KEEPEMPTYCONT) {
+            if (options & LYD_PRINT_EMPTY_CONT) {
                 /* explicit request to print, redundant to check */
                 return 1;
             }
@@ -71,7 +71,7 @@ lyd_node_should_print(const struct lyd_node *node, uint32_t options)
             return 0;
         }
     } else if ((node->flags & LYD_DEFAULT) && (node->schema->nodetype == LYS_CONTAINER)) {
-        if (options & LYD_PRINT_KEEPEMPTYCONT) {
+        if (options & LYD_PRINT_EMPTY_CONT) {
             /* explicit request to print */
             return 1;
         }

src/printer_data.c

@@ -50,7 +50,7 @@ lyd_print_(struct ly_out *out, const struct lyd_node *root, LYD_FORMAT format, u
 LIBYANG_API_DEF LY_ERR
 lyd_print_all(struct ly_out *out, const struct lyd_node *root, LYD_FORMAT format, uint32_t options)
 {
-    LY_CHECK_ARG_RET(NULL, out, !(options & LYD_PRINT_WITHSIBLINGS), LY_EINVAL);
+    LY_CHECK_ARG_RET(NULL, out, !(options & LYD_PRINT_SIBLINGS), LY_EINVAL);
 
     /* reset the number of printed bytes */
     out->func_printed = 0;
@@ -66,15 +66,15 @@ lyd_print_all(struct ly_out *out, const struct lyd_node *root, LYD_FORMAT format
     }
 
     /* print each top-level sibling */
-    LY_CHECK_RET(lyd_print_(out, root, format, options | LYD_PRINT_WITHSIBLINGS));
+    LY_CHECK_RET(lyd_print_(out, root, format, options | LYD_PRINT_SIBLINGS));
 
     return LY_SUCCESS;
 }
 
 LIBYANG_API_DEF LY_ERR
 lyd_print_tree(struct ly_out *out, const struct lyd_node *root, LYD_FORMAT format, uint32_t options)
 {
-    LY_CHECK_ARG_RET(NULL, out, !(options & LYD_PRINT_WITHSIBLINGS), LY_EINVAL);
+    LY_CHECK_ARG_RET(NULL, out, !(options & LYD_PRINT_SIBLINGS), LY_EINVAL);
 
     /* reset the number of printed bytes */
     out->func_printed = 0;

src/printer_data.h

@@ -49,7 +49,7 @@ struct ly_out;
  *
  *   Proprietary binary format that is focused on efficiency. Should always be used for best performance except for
  *   cases when the YANG context used for printing may differ from the one used for parsing, such a scenario will fail.
- *   Also, this format ignores most printing flags except for ::LYD_PRINT_WITH_SIBLINGS and ::LYD_PRINT_SHRINK
+ *   Also, this format ignores most printing flags except for ::LYD_PRINT_SIBLINGS and ::LYD_PRINT_SHRINK
  *   (functionality differs from the text formats). In addition to storing the data, this format also stores all the
  *   default values and data node flags meaning the loaded data can be used directly without any validation (unless
  *   ::LYD_PRINT_SHRINK is used).
@@ -62,7 +62,7 @@ struct ly_out;
  * [output handler](@ref howtoOutput) introduced in libyang 2.0. In contrast to
  * [schema printers](@ref howtoSchemaPrinters), there is no limit of the functionality and the functions can be used
  * interchangeable. The only think to note is that the new functions ::lyd_print_all() and ::lyd_print_tree() does not
- * accept ::LYD_PRINT_WITHSIBLINGS [printer option](@ref dataprinterflags)) since this flag differentiate the functions
+ * accept ::LYD_PRINT_SIBLINGS [printer option](@ref dataprinterflags)) since this flag differentiate the functions
  * themselves.
  *
  * Functions List
@@ -84,13 +84,13 @@ struct ly_out;
  *
  * @{
  */
-#define LYD_PRINT_WITHSIBLINGS  0x01             /**< Flag for printing also the (following) sibling nodes of the data node.
+#define LYD_PRINT_SIBLINGS  0x01                 /**< Flag for printing also the (following) sibling nodes of the data node.
                                                       The flag is not allowed for ::lyd_print_all() and ::lyd_print_tree(). */
 #define LYD_PRINT_SHRINK        LY_PRINT_SHRINK  /**< Flag for output without indentation and formatting new lines for
                                                       text formats. For the LYB format, this causes the printed data to
                                                       be shrinked to include only the necessary data making them smaller
                                                       but requiring validation. */
-#define LYD_PRINT_KEEPEMPTYCONT 0x04             /**< Preserve empty non-presence containers */
+#define LYD_PRINT_EMPTY_CONT 0x04                /**< Preserve empty non-presence containers */
 #define LYD_PRINT_EMPTY_LEAF_LIST 0x08           /**< Print even empty list and leaf-list instances, not possible for every
                                                       data format (supported only for ::LYD_JSON). */
 #define LYD_PRINT_WD_MASK       0xF0             /**< Mask for with-defaults modes */

src/printer_json.c

@@ -633,7 +633,7 @@ json_print_any_content(struct jsonpr_ctx *pctx, struct lyd_node_any *any)
         prev_parent = pctx->parent;
         prev_opts = pctx->options;
         pctx->parent = &any->node;
-        pctx->options &= ~LYD_PRINT_WITHSIBLINGS;
+        pctx->options &= ~LYD_PRINT_SIBLINGS;
         LY_LIST_FOR(any->value.tree, iter) {
             ret = json_print_node(pctx, iter);
             LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
@@ -804,7 +804,7 @@ json_print_array_is_last_inst(struct jsonpr_ctx *pctx, const struct lyd_node *no
         return 0;
     }
 
-    if ((pctx->root == node) && !(pctx->options & LYD_PRINT_WITHSIBLINGS)) {
+    if ((pctx->root == node) && !(pctx->options & LYD_PRINT_SIBLINGS)) {
         /* the only printed instance */
         return 1;
     }
@@ -1168,7 +1168,7 @@ json_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t option
     LY_LIST_FOR(root, node) {
         pctx.root = node;
         LY_CHECK_RET(json_print_node(&pctx, node));
-        if (!(options & LYD_PRINT_WITHSIBLINGS)) {
+        if (!(options & LYD_PRINT_SIBLINGS)) {
             break;
         }
     }

src/printer_lyb.c

@@ -1306,7 +1306,7 @@ lyb_print_siblings(const struct lyd_node *node, ly_bool is_root, struct lyd_lyb_
 
         LY_CHECK_RET(lyb_print_node(&node, &sibling_ht, lybctx));
 
-        if (is_root && !(lybctx->print_options & LYD_PRINT_WITHSIBLINGS)) {
+        if (is_root && !(lybctx->print_options & LYD_PRINT_SIBLINGS)) {
             break;
         }
     }

src/printer_xml.c

@@ -456,7 +456,7 @@ xml_print_anydata(struct xmlpr_ctx *pctx, const struct lyd_node_any *node)
         case LYD_ANYDATA_DATATREE:
             /* close opening tag and print data */
             prev_opts = pctx->options;
-            pctx->options &= ~LYD_PRINT_WITHSIBLINGS;
+            pctx->options &= ~LYD_PRINT_SIBLINGS;
             LEVEL_INC;
 
             ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
@@ -618,7 +618,7 @@ xml_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options
     /* content */
     LY_LIST_FOR(root, node) {
         LY_CHECK_RET(xml_print_node(&pctx, node));
-        if (!(options & LYD_PRINT_WITHSIBLINGS)) {
+        if (!(options & LYD_PRINT_SIBLINGS)) {
             break;
         }
     }

src/tree_data_common.c

@@ -1041,7 +1041,7 @@ lyd_any_value_str(const struct lyd_node *any, char **value_str)
 
     if (tree) {
         /* print into a string */
-        ret = lyd_print_mem(value_str, tree, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+        ret = lyd_print_mem(value_str, tree, LYD_XML, LYD_PRINT_SIBLINGS);
         LY_CHECK_GOTO(ret, cleanup);
     } else {
         assert(str);

tests/utests/basic/test_xpath.c

@@ -1178,7 +1178,7 @@ test_trim(void **state)
     assert_non_null(tree);
 
     assert_int_equal(LY_SUCCESS, lyd_trim_xpath(&tree, "/a:c/ll/ll[a='key11']", NULL));
-    lyd_print_mem(&str1, tree, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&str1, tree, LYD_XML, LYD_PRINT_SIBLINGS);
     assert_string_equal(str1,
             "<c xmlns=\"urn:tests:a\">\n"
             "  <ll>\n"
@@ -1198,7 +1198,7 @@ test_trim(void **state)
     assert_non_null(tree);
 
     assert_int_equal(LY_SUCCESS, lyd_trim_xpath(&tree, "/a:c/ll/ll[contains(.,'2')]", NULL));
-    lyd_print_mem(&str1, tree, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&str1, tree, LYD_XML, LYD_PRINT_SIBLINGS);
     assert_string_equal(str1,
             "<c xmlns=\"urn:tests:a\">\n"
             "  <ll>\n"
@@ -1236,7 +1236,7 @@ test_trim(void **state)
     assert_non_null(tree);
 
     assert_int_equal(LY_SUCCESS, lyd_trim_xpath(&tree, "/l1[4]//.", NULL));
-    lyd_print_mem(&str1, tree, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&str1, tree, LYD_XML, LYD_PRINT_SIBLINGS);
     assert_string_equal(str1,
             "<l1 xmlns=\"urn:tests:a\">\n"
             "  <a>a4</a>\n"

tests/utests/data/test_diff.c

@@ -21,7 +21,7 @@
         CHECK_PARSE_LYD_PARAM(INPUT, LYD_XML, LYD_PARSE_ONLY, 0, LY_SUCCESS, OUTPUT)
 
 #define CHECK_LYD_STRING(INPUT, TEXT) \
-        CHECK_LYD_STRING_PARAM(INPUT, TEXT, LYD_XML, LYD_PRINT_WITHSIBLINGS)
+        CHECK_LYD_STRING_PARAM(INPUT, TEXT, LYD_XML, LYD_PRINT_SIBLINGS)
 
 #define CHECK_PARSE_LYD_DIFF(INPUT_1, INPUT_2, OPTS, OUT_DIFF) \
         assert_int_equal(LY_SUCCESS, lyd_diff_siblings(INPUT_1, INPUT_2, OPTS, &OUT_DIFF));\
@@ -1300,7 +1300,7 @@ test_wd(void **state)
             "  <dllist yang:operation=\"create\">4</dllist>\n"
             "</df>\n";
 
-    CHECK_LYD_STRING_PARAM(diff1, diff1_out_1, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_WD_ALL);
+    CHECK_LYD_STRING_PARAM(diff1, diff1_out_1, LYD_XML, LYD_PRINT_SIBLINGS | LYD_PRINT_WD_ALL);
     assert_int_equal(lyd_diff_apply_all(&model_1, diff1), LY_SUCCESS);
     CHECK_LYD(model_1, model_2);
 
@@ -1330,7 +1330,7 @@ test_wd(void **state)
             "  <dllist yang:operation=\"create\">4</dllist>\n"
             "</df>\n";
 
-    CHECK_LYD_STRING_PARAM(diff1, diff1_out_2, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_WD_ALL);
+    CHECK_LYD_STRING_PARAM(diff1, diff1_out_2, LYD_XML, LYD_PRINT_SIBLINGS | LYD_PRINT_WD_ALL);
 
     lyd_free_all(model_1);
     lyd_free_all(model_2);
@@ -1475,7 +1475,7 @@ test_userord_list_reverse(void **state)
 
     lyd_diff_apply_all(&tree2, diff_reverse);
 
-    lyd_print_mem(&final_xml, tree2, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&final_xml, tree2, LYD_XML, LYD_PRINT_SIBLINGS);
 
     assert_string_equal(final_xml, xml1);
 
@@ -1523,7 +1523,7 @@ test_userord_conflicting_replace_list(void **state)
 
     lyd_diff_merge_all(&diff_tree1, diff_tree2, 0);
 
-    lyd_print_mem(&final_xml, diff_tree1, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&final_xml, diff_tree1, LYD_XML, LYD_PRINT_SIBLINGS);
 
     char *result_xml =
             "<df xmlns=\"urn:libyang:tests:defaults\" xmlns:yang=\"urn:ietf:params:xml:ns:yang:1\" yang:operation=\"none\">\n"
@@ -1624,7 +1624,7 @@ test_userord_conflicting_replace_list2(void **state)
 
     lyd_diff_apply_all(&tree3, diff3_1);
 
-    lyd_print_mem(&final_xml, tree3, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&final_xml, tree3, LYD_XML, LYD_PRINT_SIBLINGS);
 
     assert_string_equal(final_xml, xml2);
 
@@ -1682,7 +1682,7 @@ test_userord_conflicting_replace_llist(void **state)
 
     lyd_diff_apply_all(&tree3, diff3_1);
 
-    lyd_print_mem(&final_xml, tree3, LYD_XML, LYD_PRINT_WITHSIBLINGS);
+    lyd_print_mem(&final_xml, tree3, LYD_XML, LYD_PRINT_SIBLINGS);
 
     assert_string_equal(final_xml, xml2);
 

tests/utests/data/test_lyb.c

@@ -21,7 +21,7 @@
                 CHECK_PARSE_LYD_PARAM(INPUT, LYD_XML, LYD_PARSE_ONLY | LYD_PARSE_STRICT, 0, LY_SUCCESS, OUT_NODE)
 
 #define CHECK_LYD_STRING(MODEL, TEXT) \
-                CHECK_LYD_STRING_PARAM(MODEL, TEXT, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK)
+                CHECK_LYD_STRING_PARAM(MODEL, TEXT, LYD_XML, LYD_PRINT_SIBLINGS | LYD_PRINT_SHRINK)
 
 static void
 check_print_parse(void **state, const char *data_xml)
@@ -31,7 +31,7 @@ check_print_parse(void **state, const char *data_xml)
     char *lyb_out;
 
     CHECK_PARSE_LYD(data_xml, tree_1);
-    assert_int_equal(lyd_print_mem(&lyb_out, tree_1, LYD_LYB, LYD_PRINT_WITHSIBLINGS), 0);
+    assert_int_equal(lyd_print_mem(&lyb_out, tree_1, LYD_LYB, LYD_PRINT_SIBLINGS), 0);
     assert_int_equal(LY_SUCCESS, lyd_parse_data_mem(UTEST_LYCTX, lyb_out, LYD_LYB, LYD_PARSE_ONLY | LYD_PARSE_STRICT,
             0, &tree_2));
     assert_non_null(tree_2);
@@ -469,7 +469,7 @@ test_opaq(void **state)
     ly_in_free(in, 0);
     assert_int_equal(rc, LY_SUCCESS);
 
-    assert_int_equal(lyd_print_mem(&xml_out, tree_1, LYD_LYB, LYD_PRINT_WITHSIBLINGS), 0);
+    assert_int_equal(lyd_print_mem(&xml_out, tree_1, LYD_LYB, LYD_PRINT_SIBLINGS), 0);
 
     ly_in_new_memory(xml_out, &in);
     rc = lyd_parse_op(UTEST_LYCTX, NULL, in, LYD_LYB, LYD_TYPE_RPC_YANG, LYD_PARSE_STRICT, &tree_2, NULL);
@@ -2545,12 +2545,12 @@ test_shrink(void **state)
     /* non-shrinked */
     data_xml = "<cont xmlns=\"urn:mod\"/>";
     CHECK_PARSE_LYD_PARAM(data_xml, LYD_XML, LYD_PARSE_STRICT, LYD_VALIDATE_PRESENT, LY_SUCCESS, tree1);
-    assert_int_equal(lyd_print_mem(&lyb_out, tree1, LYD_LYB, LYD_PRINT_WITHSIBLINGS), 0);
+    assert_int_equal(lyd_print_mem(&lyb_out, tree1, LYD_LYB, LYD_PRINT_SIBLINGS), 0);
     assert_int_equal(LY_SUCCESS, lyd_parse_data_mem(UTEST_LYCTX, lyb_out, LYD_LYB, LYD_PARSE_ONLY | LYD_PARSE_STRICT,
             0, &tree2));
     assert_non_null(tree2);
 
-    assert_int_equal(LY_SUCCESS, lyd_print_mem(&str, tree2, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_WD_ALL | LYD_PRINT_SHRINK));
+    assert_int_equal(LY_SUCCESS, lyd_print_mem(&str, tree2, LYD_XML, LYD_PRINT_SIBLINGS | LYD_PRINT_WD_ALL | LYD_PRINT_SHRINK));
     assert_non_null(str);
     assert_string_equal(str, "<cont xmlns=\"urn:mod\"><l>25</l></cont>");
     free(str);
@@ -2562,7 +2562,7 @@ test_shrink(void **state)
     /* shrinked */
     data_xml = "<cont xmlns=\"urn:mod\"/>";
     CHECK_PARSE_LYD_PARAM(data_xml, LYD_XML, LYD_PARSE_STRICT, LYD_VALIDATE_PRESENT, LY_SUCCESS, tree1);
-    assert_int_equal(lyd_print_mem(&lyb_out, tree1, LYD_LYB, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK), 0);
+    assert_int_equal(lyd_print_mem(&lyb_out, tree1, LYD_LYB, LYD_PRINT_SIBLINGS | LYD_PRINT_SHRINK), 0);
     assert_int_equal(LY_SUCCESS, lyd_parse_data_mem(UTEST_LYCTX, lyb_out, LYD_LYB, LYD_PARSE_ONLY | LYD_PARSE_STRICT,
             0, &tree2));
     assert_null(tree2);