X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=stdout.c;h=f39de1090c146acd8f10578b18d637e137a4379a;hp=f857814a93ef8310669ca4138156a31394767a8c;hb=2d8f0c21ac8735fc06d1aa88e7873614392e3042;hpb=b844e3fbfb8a4fc03c83df84626b57fc8dc30ad2

diff --git a/stdout.c b/stdout.c
index f857814a..f39de109 100644
--- a/stdout.c
+++ b/stdout.c
@@ -1,3 +1,14 @@
+/*
+ * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file stdout.c functions that deal with writing to stdout */
+
+#include <dirent.h> /* readdir() */
+#include <assert.h>
+
 #include "para.h"
 #include "string.h"
 #include "list.h"
@@ -6,7 +17,16 @@
 #include "error.h"
 #include "stdout.h"
 
-void stdout_pre_select(struct sched *s, struct task *t)
+/**
+ * the pre_select function of the stdout task
+ *
+ * \param s the scheduler this task was registered to
+ * \param t the task structure of the stdout task
+ *
+ * This function is always successful. If there is data available in the input
+ * buffer, it adds \p STDOUT_FILENO to the write fd set of \a s.
+ */
+static void stdout_pre_select(struct sched *s, struct task *t)
 {
 	struct stdout_task *sot = t->private_data;
 
@@ -24,7 +44,18 @@ void stdout_pre_select(struct sched *s, struct task *t)
 	para_fd_set(STDOUT_FILENO, &s->wfds, &s->max_fileno);
 }
 
-void stdout_post_select(struct sched *s, struct task *t)
+/**
+ * the post select function of the stdout task
+ *
+ * \param s the scheduler this task was registered to
+ * \param t the task structure of the stdout task
+ *
+ * This function checks if \p STDOUT_FILENO was included by in the write fd set
+ * of \a s during the previous pre_select call.  If yes, and \p STDOUT_FILENO
+ * appeears to be writable, the data loaded in the input buffer is written to
+ * stdout.
+ */
+static void stdout_post_select(struct sched *s, struct task *t)
 {
 	struct stdout_task *sot = t->private_data;
 	ssize_t ret;
@@ -42,16 +73,26 @@ void stdout_post_select(struct sched *s, struct task *t)
 	if (ret <= 0)
 		return;
 	*sot->loaded -= ret;
+	if (*sot->loaded)
+		memmove(sot->buf, sot->buf + ret, *sot->loaded);
 	t->ret = 1;
 }
 
-void stdout_default_event_handler(struct task *t)
+static void stdout_default_event_handler(struct task *t)
 {
 	PARA_NOTICE_LOG("%p: %s\n", t, PARA_STRERROR(-t->ret));
 	unregister_task(t);
 }
 
-
+/**
+ * initialize a stdout task structure with default values
+ *
+ * \param sot the stdout task structure
+ *
+ * This fills in the pre/post select function poinzters of the task structure
+ * given by \a sot. It also sets up a default error handler which unregisters
+ * the task on errors and clears the eof flag of \a sot.
+ */
 void stdout_set_defaults(struct stdout_task *sot)
 {
 	sot->task.private_data = sot;
@@ -59,5 +100,6 @@ void stdout_set_defaults(struct stdout_task *sot)
 	sot->task.post_select = stdout_post_select;
 	sot->task.event_handler = stdout_default_event_handler;
 	sot->eof = 0;
+	mark_fd_nonblock(STDOUT_FILENO);
 	sprintf(sot->task.status, "stdout writer");
 }