Add UNIT_START errno
[paraslash.git] / stdout.c
index f857814..1656bcc 100644 (file)
--- a/stdout.c
+++ b/stdout.c
@@ -1,3 +1,23 @@
+/*
+ * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ *
+ *     This program is free software; you can redistribute it and/or modify
+ *     it under the terms of the GNU General Public License as published by
+ *     the Free Software Foundation; either version 2 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ *
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program; if not, write to the Free Software
+ *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ */
+
+/** \file stdout.c functions that deal with writing to stdout */
+
 #include "para.h"
 #include "string.h"
 #include "list.h"
@@ -6,6 +26,15 @@
 #include "error.h"
 #include "stdout.h"
 
+/**
+ * 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.
+ */
 void stdout_pre_select(struct sched *s, struct task *t)
 {
        struct stdout_task *sot = t->private_data;
@@ -24,6 +53,17 @@ void stdout_pre_select(struct sched *s, struct task *t)
        para_fd_set(STDOUT_FILENO, &s->wfds, &s->max_fileno);
 }
 
+/**
+ * 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.
+ */
 void stdout_post_select(struct sched *s, struct task *t)
 {
        struct stdout_task *sot = t->private_data;
@@ -42,16 +82,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 +109,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");
 }