]> Kevux Git Server - fll/commitdiff
Cleanup: Expand newline into two words and expand EOL into more descriptive terminology.
authorKevin Day <thekevinday@gmail.com>
Fri, 6 May 2022 05:37:52 +0000 (00:37 -0500)
committerKevin Day <thekevinday@gmail.com>
Fri, 6 May 2022 05:37:52 +0000 (00:37 -0500)
12 files changed:
level_3/fss_basic_list_read/c/fss_basic_list_read.c
level_3/fss_basic_list_write/c/private-write.h
level_3/fss_basic_write/c/private-write.h
level_3/fss_embedded_list_read/c/fss_embedded_list_read.c
level_3/fss_embedded_list_write/c/private-write.h
level_3/fss_extended_list_read/c/fss_extended_list_read.c
level_3/fss_extended_list_write/c/private-write.h
level_3/fss_extended_write/c/private-write.h
level_3/fss_payload_read/c/fss_payload_read.c
level_3/fss_payload_write/c/private-write.h
level_3/iki_read/c/iki_read.c
level_3/iki_write/c/iki_write.c

index beb3af30bbf3c9b9391e61f45d5956b06542b7e8..4d2ddde60b0861a4cc456443f4971beec476468b 100644 (file)
@@ -88,7 +88,7 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_basic_list_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_basic_list_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_basic_list_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_basic_list_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
index dac0b4df6d61f93e6309c512e1dea4e61630bf50..f559e9f1cb4c08916ccccac3bc0449ff4f182119 100644 (file)
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_basic_list_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
index 74f8c1ba8518dc89ad7508306a6e9e90ad4ce314..160c0486f97740531dc6dcf988d8faf5a36b78e8 100644 (file)
@@ -37,7 +37,7 @@ extern "C" {
 #endif // _di_fss_basic_write_error_parameter_value_missing_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
index 83474b290c26740b4d7afca2feac48eaa7f874c3..b73519f8d2e4e91ac8cb9bff30ba90dc944f02d5 100644 (file)
@@ -88,13 +88,11 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_embedded_list_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_embedded_list_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_embedded_list_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: (default) Apply all delimits.%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_all_s, context.set.notable, f_string_eol_s);
-    // @todo
-    //fl_print_format("  - %[%r%]: Apply delimits for Objects.%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_object, context.set.notable, f_string_eol_s);
     fl_print_format("  - A number, 0 or greater: apply delimits for Content at the specified depth.%r", file.stream, f_string_eol_s);
     fl_print_format("  - A number, 0 or greater, followed by a %[%r%]: (such as '1+') apply delimits for Content at the specified depth and any greater depth (numerically).%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_greater_s, context.set.notable, f_string_eol_s, f_string_eol_s);
     fl_print_format("  - A number, 0 or lesser, followed by a %[%r%]: (such as '1-') apply delimits for Content at the specified depth and any lesser depth (numerically).%r%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_lesser_s, context.set.notable, f_string_eol_s, f_string_eol_s);
index 30fba166bd5332009392da71333da87181f34e0b..e02103b42b9c45619b70d9a8cc837d239fb320d7 100644 (file)
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_embedded_list_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
index 7deb02da5245ffb59fedfdfd0eaacfeaa23215a9..b18f5ce8c120472edbc5e9c715d979d4e0941005 100644 (file)
@@ -88,7 +88,7 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_extended_list_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_extended_list_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_extended_list_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_extended_list_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
index 4f54ee71fcfaaa34b8d948bfd6139530233fb446..5bb5af070241726ae1465ea330564e21490902a8 100644 (file)
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_extended_list_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
index 9226487410af13b387fb27b97c1850d075bde317..6cce9e1ca2d1d1c516f30507e9d21f4861d2e3eb 100644 (file)
@@ -45,7 +45,7 @@ extern "C" {
 #endif // _di_fss_extended_write_error_parameter_value_missing_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
index 6725c4384ab55131110863b4b9a95e473848d791..3d363d5a3c8015cbe66c4e859ff384f403bd79f3 100644 (file)
@@ -97,7 +97,7 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_payload_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_payload_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_payload_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_payload_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
index f4d673baadd4e98be949a6b2e341e49d6b43ca4e..5681e001473864c02d9a8db268d4155560dcef10 100644 (file)
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_payload_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
index e29070d51988a90c4ec640c3a2e7c1c40f201af3..0ebb6497053d8dde11df42a8e243b024693ef4b8 100644 (file)
@@ -478,7 +478,7 @@ extern "C" {
       status = F_status_set_error(F_parameter);
     }
 
-    // Ensure a newline is always put at the end of the program execution, unless in quiet mode.
+    // Ensure a new line is always put at the end of the program execution, unless in quiet mode.
     if (main->error.verbosity != f_console_verbosity_quiet_e) {
       if (F_status_is_error(status) || !data.mode) {
         if (F_status_set_fine(status) == F_interrupt) {
index 98b4032dfed9751894c9a61f18f0a8a6eabf4534..0e5ce83014fcd7bf6fe1f97c246c95f233a60e10 100644 (file)
@@ -390,7 +390,7 @@ extern "C" {
             object_ended = F_true;
           }
 
-          // restore the range, positioned after the newline.
+          // Restore the range, positioned after the new line.
           range.start = range.stop + 2;
           range.stop = buffer.used - 1;
 
@@ -435,7 +435,7 @@ extern "C" {
           fll_print_dynamic_raw(f_string_eol_s, file.stream);
         } // for
 
-        // Ensure there is always a newline at the end, unless in quiet mode.
+        // Ensure there is always a new line at the end, unless in quiet mode.
         if (F_status_is_error_not(status) && main->error.verbosity != f_console_verbosity_quiet_e && main->parameters.array[iki_write_parameter_file_e].result == f_console_result_none_e) {
           fll_print_dynamic_raw(f_string_eol_s, file.stream);
         }
@@ -450,7 +450,7 @@ extern "C" {
       }
     }
 
-    // Ensure a newline is always put at the end of the program execution, unless in quiet mode.
+    // Ensure a new line is always put at the end of the program execution, unless in quiet mode.
     if (main->error.verbosity != f_console_verbosity_quiet_e) {
       if (F_status_is_error(status)) {
         if (F_status_set_fine(status) == F_interrupt) {