pintos-os.org Git - pspp/blob - lib/closeout.c

   1 /* closeout.c - close standard output
   2    Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 #if HAVE_CONFIG_H
  19 # include <config.h>
  20 #endif
  21
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24
  25 #if ENABLE_NLS
  26 # include <libintl.h>
  27 # define _(Text) gettext (Text)
  28 #else
  29 # define _(Text) Text
  30 #endif
  31
  32 #if HAVE_STDLIB_H
  33 # include <stdlib.h>
  34 #endif
  35 #ifndef EXIT_FAILURE
  36 # define EXIT_FAILURE 1
  37 #endif
  38
  39 #if HAVE_UNISTD_H
  40 # include <unistd.h>
  41 #endif
  42
  43 #include <stdio.h>
  44
  45 #include <errno.h>
  46 #ifndef errno
  47 extern int errno;
  48 #endif
  49
  50 #ifndef STDOUT_FILENO
  51 # define STDOUT_FILENO 1
  52 #endif
  53
  54 #include "closeout.h"
  55 #include "error.h"
  56
  57 static int default_exit_status = EXIT_FAILURE;
  58 static const char *file_name = NULL;
  59
  60 /* Set the value to be used for the exit status when close_stdout is called.
  61    This is useful when it is not convenient to call close_stdout_status,
  62    e.g., when close_stdout is called via atexit.  */
  63 void
  64 close_stdout_set_status (int status)
  65 {
  66   default_exit_status = status;
  67 }
  68
  69 /* Set the file name to be reported in the event an error is detected
  70    by close_stdout_status.  */
  71 void
  72 close_stdout_set_file_name (const char *file)
  73 {
  74   file_name = file;
  75 }
  76
  77 /* Close standard output, exiting with status STATUS on failure.
  78    If a program writes *anything* to stdout, that program should `fflush'
  79    stdout and make sure that it succeeds before exiting.  Otherwise,
  80    suppose that you go to the extreme of checking the return status
  81    of every function that does an explicit write to stdout.  The last
  82    printf can succeed in writing to the internal stream buffer, and yet
  83    the fclose(stdout) could still fail (due e.g., to a disk full error)
  84    when it tries to write out that buffered data.  Thus, you would be
  85    left with an incomplete output file and the offending program would
  86    exit successfully.
  87
  88    FIXME: note the fflush suggested above is implicit in the fclose
  89    we actually do below.  Consider doing only the fflush and/or using
  90    setvbuf to inhibit buffering.
  91
  92    Besides, it's wasteful to check the return value from every call
  93    that writes to stdout -- just let the internal stream state record
  94    the failure.  That's what the ferror test is checking below.
  95
  96    It's important to detect such failures and exit nonzero because many
  97    tools (most notably `make' and other build-management systems) depend
  98    on being able to detect failure in other tools via their exit status.  */
  99 void
 100 close_stdout_status (int status)
 101 {
 102 #ifdef EBADF
 103   struct stat sbuf;
 104   if (fstat (STDOUT_FILENO, &sbuf) && errno == EBADF)
 105     return;
 106 #endif
 107
 108   if (ferror (stdout))
 109     {
 110       if (file_name)
 111         error (status, 0, _("%s: write error"), file_name);
 112       else
 113         error (status, 0, _("write error"));
 114     }
 115
 116   if (fclose (stdout) != 0)
 117     {
 118       if (file_name)
 119         error (status, errno, _("%s: write error"), file_name);
 120       else
 121         error (status, errno, _("write error"));
 122     }
 123 }
 124
 125 /* Close standard output, exiting with status EXIT_FAILURE on failure.  */
 126 void
 127 close_stdout (void)
 128 {
 129   close_stdout_status (default_exit_status);
 130 }