queue.3: slist: Complete example

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/man3/queue.3 b/man3/queue.3
index ea43f018b01678ab7c026ed3dfc6819022f2c1bb..95bc7d5bc0d8428476b29bc173f7aa8bcfa11ab0 100644 (file)
--- a/man3/queue.3
+++ b/man3/queue.3
@@ -545,49 +545,8 @@ from the list.
 .\" .Fa head1
 .\" and
 .\" .Fa head2 .
-.Ss Singly-linked list example
-.Bd -literal
-SLIST_HEAD(slisthead, entry) head =
-    SLIST_HEAD_INITIALIZER(head);
-struct slisthead *headp;               /* Singly-linked List
-                                           head. */
-struct entry {
-       ...
-       SLIST_ENTRY(entry) entries;     /* Singly-linked List. */
-       ...
-} *n1, *n2, *n3, *np;
-
-SLIST_INIT(&head);                     /* Initialize the list. */
-
-n1 = malloc(sizeof(struct entry));     /* Insert at the head. */
-SLIST_INSERT_HEAD(&head, n1, entries);
-
-n2 = malloc(sizeof(struct entry));     /* Insert after. */
-SLIST_INSERT_AFTER(n1, n2, entries);
-
-SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */
-free(n2);
-
-n3 = SLIST_FIRST(&head);
-SLIST_REMOVE_HEAD(&head, entries);     /* Deletion from the head. */
-free(n3);
-                                       /* Forward traversal. */
-SLIST_FOREACH(np, &head, entries)
-       np\-> ...
-.\"                                    /* Safe forward traversal. */
-.\"SLIST_FOREACH_SAFE(np, &head, entries, np_temp) {
-.\"    np\->do_stuff();
-.\"    ...
-.\"    SLIST_REMOVE(&head, np, entry, entries);
-.\"    free(np);
-.\"}
-
-while (!SLIST_EMPTY(&head)) {          /* List Deletion. */
-       n1 = SLIST_FIRST(&head);
-       SLIST_REMOVE_HEAD(&head, entries);
-       free(n1);
-}
-.Ed
+.Pp
+See the EXAMPLES section below for an example program using a singly-linked list.
 .Ss Singly-linked tail queues
 A singly-linked tail queue is headed by a structure defined by the
 .Nm STAILQ_HEAD
@@ -1409,6 +1368,63 @@ while (n1 != (void *)&head) {
 CIRCLEQ_INIT(&head);
 .Ed
 .Sh EXAMPLES
+.Ss Singly-linked list example
+.Bd -literal
+
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/queue.h>
+
+struct entry {
+    int data;
+    SLIST_ENTRY(entry) entries;             /* Singly-linked List. */
+};
+
+SLIST_HEAD(slisthead, entry);
+
+int
+main(void)
+{
+    struct entry    *n1, *n2, *n3, *np;
+    struct slisthead head;                  /* Singly-linked List
+                                               head. */
+
+    SLIST_INIT(&head);                      /* Initialize the queue. */
+
+    n1 = malloc(sizeof(struct entry));      /* Insert at the head. */
+    SLIST_INSERT_HEAD(&head, n1, entries);
+
+    n2 = malloc(sizeof(struct entry));      /* Insert after. */
+    SLIST_INSERT_AFTER(n1, n2, entries);
+
+    SLIST_REMOVE(&head, n2, entry, entries);/* Deletion. */
+    free(n2);
+
+    n3 = SLIST_FIRST(&head);
+    SLIST_REMOVE_HEAD(&head, entries);      /* Deletion from the head. */
+    free(n3);
+
+    for (int i = 0; i < 5; i++) {
+        n1 = malloc(sizeof(struct entry));
+        SLIST_INSERT_HEAD(&head, n1, entries);
+        n1->data = i;
+    }
+
+                                            /* Forward traversal. */
+    SLIST_FOREACH(np, &head, entries)
+        printf("%i\en", np->data);
+
+    while (!SLIST_EMPTY(&head)) {           /* List Deletion. */
+        n1 = SLIST_FIRST(&head);
+        SLIST_REMOVE_HEAD(&head, entries);
+        free(n1);
+    }
+    SLIST_INIT(&head);
+
+    exit(EXIT_SUCCESS);
+}
+.Ed
 .Ss Tail queue example
 .Bd -literal
 #include <stddef.h>