* [PATCH] queue.3: stailq: Complete example
@ 2020-10-17 10:16 Alejandro Colomar
2020-10-17 10:26 ` Michael Kerrisk (man-pages)
0 siblings, 1 reply; 2+ messages in thread
From: Alejandro Colomar @ 2020-10-17 10:16 UTC (permalink / raw)
To: mtk.manpages; +Cc: Alejandro Colomar, linux-man, libc-alpha
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man3/queue.3 | 117 ++++++++++++++++++++++++++++-----------------------
1 file changed, 64 insertions(+), 53 deletions(-)
diff --git a/man3/queue.3 b/man3/queue.3
index 9cd6ff378..c48b4ba9f 100644
--- a/man3/queue.3
+++ b/man3/queue.3
@@ -721,59 +721,9 @@ from the tail queue.
.\" .Fa head1
.\" and
.\" .Fa head2 .
-.Ss Singly-linked tail queue example
-.Bd -literal
-STAILQ_HEAD(stailhead, entry) head =
- STAILQ_HEAD_INITIALIZER(head);
-struct stailhead *headp; /* Singly-linked tail queue head. */
-struct entry {
- ...
- STAILQ_ENTRY(entry) entries; /* Tail queue. */
- ...
-} *n1, *n2, *n3, *np;
-
-STAILQ_INIT(&head); /* Initialize the queue. */
-
-n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
-STAILQ_INSERT_HEAD(&head, n1, entries);
-
-n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */
-STAILQ_INSERT_TAIL(&head, n1, entries);
-
-n2 = malloc(sizeof(struct entry)); /* Insert after. */
-STAILQ_INSERT_AFTER(&head, n1, n2, entries);
- /* Deletion. */
-STAILQ_REMOVE(&head, n2, entry, entries);
-free(n2);
- /* Deletion from the head. */
-n3 = STAILQ_FIRST(&head);
-STAILQ_REMOVE_HEAD(&head, entries);
-free(n3);
- /* Forward traversal. */
-STAILQ_FOREACH(np, &head, entries)
- np\-> ...
-.\" /* Safe forward traversal. */
-.\"STAILQ_FOREACH_SAFE(np, &head, entries, np_temp) {
-.\" np\->do_stuff();
-.\" ...
-.\" STAILQ_REMOVE(&head, np, entry, entries);
-.\" free(np);
-.\"}
- /* TailQ Deletion. */
-while (!STAILQ_EMPTY(&head)) {
- n1 = STAILQ_FIRST(&head);
- STAILQ_REMOVE_HEAD(&head, entries);
- free(n1);
-}
- /* Faster TailQ Deletion. */
-n1 = STAILQ_FIRST(&head);
-while (n1 != NULL) {
- n2 = STAILQ_NEXT(n1, entries);
- free(n1);
- n1 = n2;
-}
-STAILQ_INIT(&head);
-.Ed
+.Pp
+See the EXAMPLES section below for an example program
+using a singly-linked tail queue.
.Ss Lists
A list is headed by a structure defined by the
.Nm LIST_HEAD
@@ -1328,6 +1278,67 @@ main(void)
exit(EXIT_SUCCESS);
}
.Ed
+.Ss Singly-linked tail queue example
+.Bd -literal
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/queue.h>
+
+struct entry {
+ int data;
+ STAILQ_ENTRY(entry) entries; /* Singly-linked tail queue. */
+};
+
+STAILQ_HEAD(stailhead, entry);
+
+int
+main(void)
+{
+ struct entry *n1, *n2, *n3, *np;
+ struct stailhead head; /* Singly-linked tail queue
+ head. */
+
+ STAILQ_INIT(&head); /* Initialize the queue. */
+
+ n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
+ STAILQ_INSERT_HEAD(&head, n1, entries);
+
+ n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */
+ STAILQ_INSERT_TAIL(&head, n1, entries);
+
+ n2 = malloc(sizeof(struct entry)); /* Insert after. */
+ STAILQ_INSERT_AFTER(&head, n1, n2, entries);
+
+ STAILQ_REMOVE(&head, n2, entry, entries);/* Deletion. */
+ free(n2);
+
+ n3 = STAILQ_FIRST(&head);
+ STAILQ_REMOVE_HEAD(&head, entries); /* Deletion from the head. */
+ free(n3);
+
+ n1 = STAILQ_FIRST(&head);
+ n1->data = 0;
+ for (int i = 1; i < 5; i++) {
+ n1 = malloc(sizeof(struct entry));
+ STAILQ_INSERT_HEAD(&head, n1, entries);
+ n1->data = i;
+ }
+ /* Forward traversal. */
+ STAILQ_FOREACH(np, &head, entries)
+ printf("%i\en", np->data);
+ /* TailQ Deletion. */
+ n1 = STAILQ_FIRST(&head);
+ while (n1 != NULL) {
+ n2 = STAILQ_NEXT(n1, entries);
+ free(n1);
+ n1 = n2;
+ }
+ STAILQ_INIT(&head);
+
+ exit(EXIT_SUCCESS);
+}
+.Ed
.Ss List example
.Bd -literal
#include <stddef.h>
--
2.28.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] queue.3: stailq: Complete example
2020-10-17 10:16 [PATCH] queue.3: stailq: Complete example Alejandro Colomar
@ 2020-10-17 10:26 ` Michael Kerrisk (man-pages)
0 siblings, 0 replies; 2+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-10-17 10:26 UTC (permalink / raw)
To: Alejandro Colomar; +Cc: mtk.manpages, linux-man, libc-alpha
On 10/17/20 12:16 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
Thanks, Alex. Patch applied.
Cheers,
Michael
> ---
> man3/queue.3 | 117 ++++++++++++++++++++++++++++-----------------------
> 1 file changed, 64 insertions(+), 53 deletions(-)
>
> diff --git a/man3/queue.3 b/man3/queue.3
> index 9cd6ff378..c48b4ba9f 100644
> --- a/man3/queue.3
> +++ b/man3/queue.3
> @@ -721,59 +721,9 @@ from the tail queue.
> .\" .Fa head1
> .\" and
> .\" .Fa head2 .
> -.Ss Singly-linked tail queue example
> -.Bd -literal
> -STAILQ_HEAD(stailhead, entry) head =
> - STAILQ_HEAD_INITIALIZER(head);
> -struct stailhead *headp; /* Singly-linked tail queue head. */
> -struct entry {
> - ...
> - STAILQ_ENTRY(entry) entries; /* Tail queue. */
> - ...
> -} *n1, *n2, *n3, *np;
> -
> -STAILQ_INIT(&head); /* Initialize the queue. */
> -
> -n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
> -STAILQ_INSERT_HEAD(&head, n1, entries);
> -
> -n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */
> -STAILQ_INSERT_TAIL(&head, n1, entries);
> -
> -n2 = malloc(sizeof(struct entry)); /* Insert after. */
> -STAILQ_INSERT_AFTER(&head, n1, n2, entries);
> - /* Deletion. */
> -STAILQ_REMOVE(&head, n2, entry, entries);
> -free(n2);
> - /* Deletion from the head. */
> -n3 = STAILQ_FIRST(&head);
> -STAILQ_REMOVE_HEAD(&head, entries);
> -free(n3);
> - /* Forward traversal. */
> -STAILQ_FOREACH(np, &head, entries)
> - np\-> ...
> -.\" /* Safe forward traversal. */
> -.\"STAILQ_FOREACH_SAFE(np, &head, entries, np_temp) {
> -.\" np\->do_stuff();
> -.\" ...
> -.\" STAILQ_REMOVE(&head, np, entry, entries);
> -.\" free(np);
> -.\"}
> - /* TailQ Deletion. */
> -while (!STAILQ_EMPTY(&head)) {
> - n1 = STAILQ_FIRST(&head);
> - STAILQ_REMOVE_HEAD(&head, entries);
> - free(n1);
> -}
> - /* Faster TailQ Deletion. */
> -n1 = STAILQ_FIRST(&head);
> -while (n1 != NULL) {
> - n2 = STAILQ_NEXT(n1, entries);
> - free(n1);
> - n1 = n2;
> -}
> -STAILQ_INIT(&head);
> -.Ed
> +.Pp
> +See the EXAMPLES section below for an example program
> +using a singly-linked tail queue.
> .Ss Lists
> A list is headed by a structure defined by the
> .Nm LIST_HEAD
> @@ -1328,6 +1278,67 @@ main(void)
> exit(EXIT_SUCCESS);
> }
> .Ed
> +.Ss Singly-linked tail queue example
> +.Bd -literal
> +#include <stddef.h>
> +#include <stdio.h>
> +#include <stdlib.h>
> +#include <sys/queue.h>
> +
> +struct entry {
> + int data;
> + STAILQ_ENTRY(entry) entries; /* Singly-linked tail queue. */
> +};
> +
> +STAILQ_HEAD(stailhead, entry);
> +
> +int
> +main(void)
> +{
> + struct entry *n1, *n2, *n3, *np;
> + struct stailhead head; /* Singly-linked tail queue
> + head. */
> +
> + STAILQ_INIT(&head); /* Initialize the queue. */
> +
> + n1 = malloc(sizeof(struct entry)); /* Insert at the head. */
> + STAILQ_INSERT_HEAD(&head, n1, entries);
> +
> + n1 = malloc(sizeof(struct entry)); /* Insert at the tail. */
> + STAILQ_INSERT_TAIL(&head, n1, entries);
> +
> + n2 = malloc(sizeof(struct entry)); /* Insert after. */
> + STAILQ_INSERT_AFTER(&head, n1, n2, entries);
> +
> + STAILQ_REMOVE(&head, n2, entry, entries);/* Deletion. */
> + free(n2);
> +
> + n3 = STAILQ_FIRST(&head);
> + STAILQ_REMOVE_HEAD(&head, entries); /* Deletion from the head. */
> + free(n3);
> +
> + n1 = STAILQ_FIRST(&head);
> + n1->data = 0;
> + for (int i = 1; i < 5; i++) {
> + n1 = malloc(sizeof(struct entry));
> + STAILQ_INSERT_HEAD(&head, n1, entries);
> + n1->data = i;
> + }
> + /* Forward traversal. */
> + STAILQ_FOREACH(np, &head, entries)
> + printf("%i\en", np->data);
> + /* TailQ Deletion. */
> + n1 = STAILQ_FIRST(&head);
> + while (n1 != NULL) {
> + n2 = STAILQ_NEXT(n1, entries);
> + free(n1);
> + n1 = n2;
> + }
> + STAILQ_INIT(&head);
> +
> + exit(EXIT_SUCCESS);
> +}
> +.Ed
> .Ss List example
> .Bd -literal
> #include <stddef.h>
>
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-10-17 10:26 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-17 10:16 [PATCH] queue.3: stailq: Complete example Alejandro Colomar
2020-10-17 10:26 ` Michael Kerrisk (man-pages)
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).