libDwm-0.6.0
DwmReadable.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmReadable.hh 8401 $
3 // @(#) $Id: DwmReadable.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
34 // PATENT, TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 
42 #ifndef _DWMREADABLE_HH_
43 #define _DWMREADABLE_HH_
44 
45 extern "C" {
46  #include <sys/types.h>
47  #include <stdio.h>
48 }
49 
50 #include <iostream>
51 
52 namespace Dwm {
53 
54  //--------------------------------------------------------------------------
57  //--------------------------------------------------------------------------
58  class Readable
59  {
60  public:
61  //------------------------------------------------------------------------
63  //------------------------------------------------------------------------
64  virtual ~Readable() { }
65 
66  //------------------------------------------------------------------------
68  //------------------------------------------------------------------------
69  virtual std::istream & Read(std::istream & is) = 0;
70 
71  //------------------------------------------------------------------------
74  //------------------------------------------------------------------------
75  virtual ssize_t Read(int fd) = 0;
76 
77  //------------------------------------------------------------------------
80  //------------------------------------------------------------------------
81  virtual size_t Read(FILE * f) = 0;
82  };
83 
84 } // namespace Dwm
85 
86 #endif // _DWMREADABLE_HH_
87 
88 //---------------------------- emacs settings -----------------------------
89 // Local Variables:
90 // mode: C++/la
91 // tab-width: 2
92 // indent-tabs-mode: nil
93 // c-basic-offset: 2
94 // End:
95 //-------------------------------------------------------------------------
virtual ~Readable()
destructor
Definition: DwmReadable.hh:64
virtual std::istream & Read(std::istream &is)=0
Read from an istream. Return the istream.
Definition: DwmBZ2IO.hh:67
This class defines an interface for classes that can read their contents from an istream, file descriptor or FILE pointer.
Definition: DwmReadable.hh:58