summaryrefslogtreecommitdiffstats
path: root/filters/kword/starwriter/pole.h
blob: 20ca63800807a56eb33bda271dd62b15557d1807 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/* POLE - Portable library to access OLE Storage 
   Copyright (C) 2002-2003 Ariya Hidayat <ariya@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
   
   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA
*/

#ifndef POLE_H
#define POLE_H

#include <string>
#include <list>

namespace POLE
{

class StorageIO;
class Stream;

class Storage
{

public:

  enum { Ok, OpenFailed, NotOLE, BadOLE, UnknownError, 
    StupidWorkaroundForBrokenCompiler=255 };

  enum { ReadOnly, WriteOnly, ReadWrite };

  Storage();

  ~Storage();

  /**
   * Opens the specified file, using the mode m.
   *
   * @return true if succesful, otherwise false.
   */
  bool open( const char* filename, int m = ReadOnly );

  /**
   * Flushes the buffer to the disk.
   */
  void flush();

  /**
   * Closes the storage.
   *
   * If it was opened using WriteOnly or ReadWrite, this function
   * also flushes the buffer.
   */
  void close();

  std::list<std::string> listDirectory();

  bool enterDirectory( const std::string& directory );

  void leaveDirectory();

  std::string path();

  /**
   * Creates an input/output stream for specified name. You should 
   * delete the stream because it is not owned by the storage.
   *
   * If name does not exist or is a directory, this function
   * will return null.
   */
  Stream* stream( const std::string& name );

  int result;

protected:

  StorageIO* io;

private:

  // no copy or assign
  Storage( const Storage& );
  Storage& operator=( const Storage& );

};

class StreamIO;

class Stream
{
  public:

    Stream( StreamIO* io );

    ~Stream();

    unsigned long size();

    unsigned long tell();

    void seek( unsigned long pos ); 

    int getch();

    unsigned long read( unsigned char* data, unsigned long maxlen );

  private:

    StreamIO* io;

    // no copy or assign
    Stream( const Stream& );
    Stream& operator=( const Stream& );
};


}

#endif // POLE_H