WIP 75 - Silence compiler warning, move compat test suite file

Silence compiler warning:
macro-expanded `macro_export` macros from the current crate cannot be
referred to by absolute paths
rust-lang/rust#52234

By adding this to lib.rs:

This is a warning for a future error in the compiler. It does not allow
$crate to be used by this macro as_str_slice_test_case! if the macro is
used inside the crate, and by other crates. One solution is just to
require anyone who uses this macro to import the appropriate symbols,
kind of like what you have to do with use `std::fmt::Write as _` before
calling write!

Also, move the compat test suite file to the top level parser_ng folder
instead of being located in the sub-folder "as_str_slice_core". And
rename "core.rs" to "as_str_slice_core.rs" since "core" is used else
where in the code base to refer to the top-level "core" module.

Author: nazmulidris

todo.md

@@ -245,15 +245,15 @@
 - [x] update `md_parser_syn_hi_impl.rs` to use this. provide a new `bool` flag that allows the new
       `_ng` parser active instead of the old one (keep them all in the code for now). there is 1
       function that is shared between the two, so move that to `_ng` for smart code block tests.
-- [ ] add a new test case in `parse_heading_ng()` test cases, and use the markdown constant from the
+- [x] add a new test case in `parse_heading_ng()` test cases, and use the markdown constant from the
       demo examples for the editor, which currently shows up in 2 places (consolidate them into
       one):
   - `get_real_world_content()` in
     `tui/src/tui/md_parser_ng/as_str_slice/compatibility_test_suite.rs`
   - `get_default_content()` in `tui/examples/tui_apps/ex_editor/state.rs`
-- [ ] make quality and compatibility improvments to `md_parse_ng` now that it is attached to the
-      test examples. there is an extra new line at the bottom of the editor for some reason that
-      does not show up with the legacy parser.
+- [x] make quality and compatibility improvments to `md_parse_ng` now that it is attached to the
+      test examples. verify that extra line at the bottom of editor example shows up both for legacy
+      and NG parser
 - [ ] use `cargo bench` in `compatibility_test_suite.rs` to compare the relative performance of both
       legacy and NG parsers
 - [ ] would it be possible to cache the AST returned by `parse_markdown_ng()`? is this a tree

tui/src/lib.rs

@@ -1010,6 +1010,8 @@
 #![warn(clippy::unwrap_in_result)]
 #![warn(rust_2018_idioms)]
 #![allow(clippy::literal_string_with_formatting_args)]
+// Disable the following to allow as_str_slice_test_case! to continue working.
+#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]
 
 // Attach.
 pub mod core;

tui/src/tui/md_parser_ng/as_str_slice/core.rs renamed to tui/src/tui/md_parser_ng/as_str_slice/as_str_slice_core.rs

@@ -337,6 +337,21 @@ where
 /// as_str_slice_test_case!(slice, "", "foo", "");
 /// assert_eq!(slice.to_inline_string(), "\nfoo\n\n");
 /// ```
+///
+/// # Compiler warning about `macro_export` macros from the current crate cannot be referred to by absolute paths
+///
+/// This is a warning for a future error in the compiler. It does not allow
+/// `$crate` to be used by this macro `as_str_slice_test_case!` if the macro is
+/// used inside the crate, and by other crates.
+///
+/// - More info: <https://github.com/rust-lang/rust/pull/52234>
+/// - Workaround for now: It is currently suppressed by adding this to `lib.rs`:
+///   `#![allow(macro_expanded_macro_exports_accessed_by_absolute_paths)]`
+///
+/// One solution is just to require anyone who uses this macro to import the appropriate
+/// symbols, kind of like what you have to do with use `std::fmt::Write as _` before
+/// calling `write!`. Also, `::r3bl_tui` can't be used, and neither is `r3bl_tui::` to
+/// import the `GCString` and `AsStrSlice` structs.
 #[macro_export]
 macro_rules! as_str_slice_test_case {
     ($var_name:ident, $($string_expr:expr),+ $(,)?) => {
@@ -353,7 +368,7 @@ macro_rules! as_str_slice_test_case {
 
 #[cfg(test)]
 mod tests_as_str_slice_test_case {
-    use crate::{as_str_slice_test_case, assert_eq2};
+    use crate::assert_eq2;
 
     #[test]
     fn test_as_str_slice_creation() {
@@ -481,9 +496,10 @@ impl CharLengthExt for &str {
 /// Unit tests for the [crate::AsStrSlice] struct and its methods.
 #[cfg(test)]
 mod tests_as_str_slice_basic_functionality {
+    use as_str_slice_test_case;
     use nom::Input;
 
-    use crate::{as_str_slice_test_case, assert_eq2, idx, len, AsStrSlice};
+    use crate::{assert_eq2, idx, len, AsStrSlice};
 
     #[test]
     fn test_gc_string_slice_basic_functionality() {

tui/src/tui/md_parser_ng/as_str_slice/mod.rs

@@ -89,20 +89,29 @@
 //! documentation on the [`AsStrSlice`] struct.**
 
 // Attach.
+#[rustfmt::skip]
 pub mod compatibility;
-#[cfg(test)]
-pub mod compatibility_test_suite;
-pub mod core;
+#[rustfmt::skip]
+pub mod as_str_slice_core;
+#[rustfmt::skip]
 pub mod iterators;
+#[rustfmt::skip]
 pub mod operations;
+#[rustfmt::skip]
 pub mod position;
+#[rustfmt::skip]
 pub mod traits;
 
 // Re-export.
-pub use core::*;
-
+#[rustfmt::skip] 
+pub use as_str_slice_core::*;
+#[rustfmt::skip] 
 pub use compatibility::*;
+#[rustfmt::skip] 
 pub use iterators::*;
+#[rustfmt::skip] 
 pub use operations::*;
+#[rustfmt::skip] 
 pub use position::*;
+#[rustfmt::skip] 
 pub use traits::*;

tui/src/tui/md_parser_ng/as_str_slice/compatibility_test_suite.rs renamed to tui/src/tui/md_parser_ng/compatibility_test_suite.rs

@@ -514,4 +514,4 @@ mod tests_parse_markdown_compatibility {
         // Test with H1 to see if it's specific to H2
         test_compatibility_helper("emoji_h1_with_list", "# Heading 😀\n\n1. List item");
     }
-}
+}

tui/src/tui/md_parser_ng/mod.rs

@@ -102,6 +102,10 @@ pub use fragment_ng::*;
 pub use parse_markdown_ng::*;
 pub use standard_ng::*;
 
+// Attach test sources.
+#[cfg(test)]
+pub mod compatibility_test_suite;
+
 // Export for tests and examples.
 /// Returns the real-world markdown content from the ex_editor example.
 /// This content includes emojis in headings, nested lists, code blocks, metadata,