From 40873e52245ce8d6e144d6cea3dc0bc254c7d492 Mon Sep 17 00:00:00 2001
From: Patrick Pelissier <patrick.pelissier@gmail.com>
Date: Mon, 1 May 2017 17:23:51 +0200
Subject: [PATCH] Update example

---
 example/ex06.c | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

diff --git a/example/ex06.c b/example/ex06.c
index b9463f6e..48b6d8b5 100644
--- a/example/ex06.c
+++ b/example/ex06.c
@@ -8,43 +8,63 @@
 #include "m-string.h"
 #include "m-algo.h"
 
+// Let's create a list of string.
 LIST_DEF(string, string_t, STRING_OPLIST)
+
+// Let's define its oplist with a shorter name
 #define ASTR_OPLIST LIST_OPLIST(string, STRING_OPLIST)
+
+// Let's define some basic algorithms over this list of string.
 ALGO_DEF(astring, ASTR_OPLIST)
 
 int main(void)
 {
   // Let's create a variable named 'grow' which is a list of string_t
+  // This variable is only defined within the associated '{' '}' block.
+  // You can also define the variable (list_string_t) and use explicitely
+  // its constructor (list_string_init) / destructor (list_string_clear).
   M_LET (grow, ASTR_OPLIST)
-    M_LET (tmpstr, STRING_OPLIST) { // And let's create a string_t
+    M_LET (tmpstr, STRING_OPLIST) { // And let's create also a string_t
 
-    // add string elements to the array
+    // add string elements to the list
     list_string_push_back (grow, STRING_CTE("AB"));
     string_printf(tmpstr, "%d", 12);
     list_string_push_back (grow, tmpstr);
     list_string_push_back (grow, STRING_CTE("CD"));
 
-    // get the chunk as a big string
+    // Serialize the list of string into a big string.
     list_string_get_str (tmpstr, grow, false);
 
     // print out
     printf("Number of elements = %lu\n", (unsigned long) list_string_size(grow));
     printf("Final string = %s\n", string_get_cstr(tmpstr));
 
-    // Another way to print the list
+    // Let's iterate over each element of the list
+    // using the macro for iteration over a container.
+    printf ("Using macro EACH :\n");
     for M_EACH (item, grow, ASTR_OPLIST) {
         printf ("Item = ");
         string_fputs (stdout, *item);
         printf ("\n");
       }
 
+    // You can also use classic iterator:
+    list_it_string_t it;
+    printf ("Using iterators :\n");
+    for(list_string_it(it, grow) ; !list_string_end_p(it) ; list_string_next(it)) {
+      const string_t *item = list_string_cref (it);
+      printf ("Item = ");
+      string_fputs (stdout, *item);
+      printf ("\n");
+    }
+
     // Get the min and the max of the list
     string_t *p = astring_min(grow);
     printf ("Min string is %s\n", string_get_cstr(*p));
     p = astring_max(grow);
     printf ("Max string is %s\n", string_get_cstr(*p));
 
-    // We can even sort the list!
+    // We can even sort the list.
     astring_sort(grow);
     for M_EACH (item, grow, ASTR_OPLIST) {
         printf ("Sort Item = %s\n", string_get_cstr(*item) );