libDwm-0.6.0
DwmWritable.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmWritable.hh 8401 $
3 // @(#) $Id: DwmWritable.hh 8401 2016-04-17 06:44:31Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2004-2007
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // 1. Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // 2. Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // 3. The names of the authors and copyright holders may not be used to
18 // endorse or promote products derived from this software without
19 // specific prior written permission.
20 //
21 // IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
22 // DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
23 // INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
24 // EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
25 // DAMAGE.
26 //
27 // THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
28 // DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
29 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
30 // REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
31 // IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 // WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
33 // PURPOSE, OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
34 // TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 #ifndef _DWMWRITABLE_HH_
42 #define _DWMWRITABLE_HH_
43 
44 extern "C" {
45  #include <sys/types.h>
46  #include <inttypes.h>
47  #include <stdio.h>
48 }
49 
50 #include <iostream>
51 
52 namespace Dwm {
53 
54  //--------------------------------------------------------------------------
57  //--------------------------------------------------------------------------
58  class Writable
59  {
60  public:
61  //------------------------------------------------------------------------
63  //------------------------------------------------------------------------
64  virtual ~Writable() { }
65 
66  //------------------------------------------------------------------------
68  //------------------------------------------------------------------------
69  virtual std::ostream & Write(std::ostream & os) const = 0;
70 
71  //------------------------------------------------------------------------
74  //------------------------------------------------------------------------
75  virtual ssize_t Write(int fd) const = 0;
76 
77  //------------------------------------------------------------------------
80  //------------------------------------------------------------------------
81  virtual size_t Write(FILE *f) const = 0;
82 
83  //------------------------------------------------------------------------
86  //------------------------------------------------------------------------
87  virtual uint32_t StreamedLength() const = 0;
88  };
89 
90 
91 } // namespace Dwm
92 
93 #endif // _DWMWRITABLE_HH_
94 
95 //---------------------------- emacs settings -----------------------------
96 // Local Variables:
97 // mode: C++/la
98 // tab-width: 2
99 // indent-tabs-mode: nil
100 // c-basic-offset: 2
101 // End:
102 //-------------------------------------------------------------------------
virtual ~Writable()
Destructor.
Definition: DwmWritable.hh:64
virtual std::ostream & Write(std::ostream &os) const =0
Write to an ostream. Return the ostream.
virtual uint32_t StreamedLength() const =0
Returns the number of bytes that should be written if one of the Write() members is called...
Definition: DwmBZ2IO.hh:67
This class defines an interface for classes that can write their contents to an ostream, file descriptor or FILE pointer.
Definition: DwmWritable.hh:58