libs/pbd/pbd/transmitter.h

   1 /*
   2     Copyright (C) 1998-99 Paul Barton-Davis
   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 of the License, or
   7     (at your option) 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
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __libmisc_transmitter_h__
  21 #define __libmisc_transmitter_h__
  22
  23 #include <sstream>
  24 #include <iostream>
  25
  26 #include <pbd/signals.h>
  27
  28 #include "pbd/libpbd_visibility.h"
  29
  30 class LIBPBD_API Transmitter : public std::stringstream
  31
  32 {
  33   public:
  34         enum Channel {
  35                 Info,
  36                 Error,
  37                 Warning,
  38                 Fatal,
  39                 Throw
  40         };
  41
  42         Transmitter (Channel);
  43
  44         PBD::Signal2<void,Channel, const char *> &sender() {
  45                 return *send;
  46         }
  47
  48         bool does_not_return ();
  49
  50   protected:
  51         virtual void deliver ();
  52         friend std::ostream& endmsg (std::ostream &);
  53
  54   private:
  55         Channel channel;
  56         PBD::Signal2<void, Channel, const char *> *send;
  57
  58         PBD::Signal2<void, Channel, const char *> info;
  59         PBD::Signal2<void, Channel, const char *> warning;
  60         PBD::Signal2<void, Channel, const char *> error;
  61         PBD::Signal2<void, Channel, const char *> fatal;
  62 };
  63
  64 /* for EGCS 2.91.66, if this function is not compiled within the same
  65    compilation unit as the one where a ThrownError is thrown, then
  66    nothing will catch the error. This is a pretty small function, so
  67    inlining it here seems like a reasonable workaround.
  68 */
  69
  70 inline std::ostream &
  71 endmsg (std::ostream &ostr)
  72
  73 {
  74         Transmitter *t;
  75
  76         /* There is a serious bug in the Cygnus/GCC libstdc++ library:
  77            cout is not actually an ostream, but a trick was played
  78            to make the compiler think that it is. This will cause
  79            the dynamic_cast<> to fail with SEGV. So, first check to
  80            see if ostr == cout, and handle it specially.
  81         */
  82
  83         if (&ostr == &std::cout) {
  84                 std::cout << std::endl;
  85                 return ostr;
  86         } else if (&ostr == &std::cerr) {
  87                 std::cerr << std::endl;
  88                 return ostr;
  89         }
  90
  91         if ((t = dynamic_cast<Transmitter *> (&ostr)) != 0) {
  92                 t->deliver ();
  93         } else {
  94                 /* hmm. not a Transmitter, so just put a newline on
  95                    it and assume that that will be enough.
  96                 */
  97
  98                 ostr << std::endl;
  99         }
 100
 101         return ostr;
 102 }
 103
 104
 105 extern "C" { LIBPBD_API void pbd_c_error (const char *); }
 106
 107 #endif // __libmisc_transmitter_h__