Merge pull request #1066 from vsbogd/sort-docs

Sort docs

Author: vsbogd

lib/src/metta/runner/stdlib/stdlib.metta

@@ -1264,6 +1264,12 @@ Possible pragmas:
     (@param "Atoms to be placed inside expression instead of {}")))
   (@return "Expression with replaced {} with atoms"))
 
+(@doc sort-strings
+  (@desc "Sorts expression which contains strings in alphabet order")
+  (@params (
+    (@param "List of strings")))
+  (@return "Sorted list of strings"))
+
 (@doc sealed
   (@desc "Replaces all occurrences of any var inside atom (second argument) by unique variable, except list of variables to ignore (first argument). Can be used to create a locally scoped variables")
   (@params (

lib/src/metta/runner/stdlib/string.rs

@@ -1,4 +1,5 @@
 use hyperon_atom::*;
+use hyperon_atom::gnd::GroundedFunctionAtom;
 use crate::metta::*;
 use crate::metta::text::Tokenizer;
 use hyperon_atom::gnd::str::*;
@@ -60,13 +61,32 @@ impl CustomExecute for FormatArgsOp {
     }
 }
 
+fn sort_strings(args: &[Atom]) -> Result<Vec<Atom>, ExecError> {
+    let arg_error = "sort-strings expects expression with strings as a first argument";
+    let list = TryInto::<&ExpressionAtom>::try_into(args.get(0).ok_or(arg_error)?).map_err(|_| arg_error)?;
+    let mut strings = Vec::<&str>::with_capacity(list.children().len());
+    for s in list.children() {
+        let s = Atom::as_gnd::<Str>(s).ok_or(arg_error)?;
+        strings.push(s.as_str());
+    }
+    strings.sort();
+    let sorted: Vec::<Atom> = strings.into_iter()
+        .map(|s| Atom::gnd(Str::from_string(s.into()))).collect();
+    Ok(vec![Atom::expr(sorted)])
+}
+
 pub(super) fn register_context_independent_tokens(tref: &mut Tokenizer) {
     let println_op = Atom::gnd(PrintlnOp{});
     tref.register_token(regex(r"println!"), move |_| { println_op.clone() });
     let format_args_op = Atom::gnd(FormatArgsOp{});
     tref.register_token(regex(r"format-args"), move |_| { format_args_op.clone() });
     tref.register_token(regex(r#"(?s)^".*"$"#),
         |token| { let mut s = String::from(token); s.remove(0); s.pop(); Atom::gnd(Str::from_string(s)) });
+    tref.register_function(GroundedFunctionAtom::new(
+        r"sort-strings".into(), 
+        expr!("->" "Expression" "Expression"),
+        sort_strings
+    ));
 }
 
 #[cfg(test)]

lib/tests/test_stdlib.metta

@@ -131,3 +131,6 @@
 (issue911 A B)
 (= (isa911 $x $y) (match &self (issue911 $x $y) True))
 !(assertEqual ((isa911 $a B) $a) (True A))
+
+; Test sort-strings function
+!(assertEqual (sort-strings ("c" "b" "a" "c")) ("a" "b" "c" "c"))

mkdocs.metta

@@ -45,11 +45,12 @@
 (= (document-module $title $mod)
   (let $_ (import! &self $mod)
   (let $helps (collapse (help-md-space! (module-space-no-deps (mod-space! $mod))))
-  (let $text (foldl-atom $helps "" $r $i (format-args "{}{}" ($r $i)))
+  (let $sorted (sort-strings $helps)
+  (let $text (foldl-atom $sorted "" $r $i (format-args "{}{}" ($r $i)))
   (let $md (format-args "# {}\n{}" ($title $text))
   (let $path (format-args "./docs/{}.md" ($mod))
   (let $file (file-open! $path "wct")
-    (file-write! $file $md) )))))))
+    (file-write! $file $md) ))))))))
 
 !(document-module "Standard library" corelib)
 !(document-module "File Input/Output" fileio)