summaryrefslogtreecommitdiffstats
path: root/akode/lib/localfile.h
blob: 7f7c2c21488eb2f27224ab5d427e0a64e811e4aa (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
/*  aKode: LocalFile-type

    Copyright (C) 2004 Allan Sandfeld Jensen <kde@carewolf.com>

    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 Steet, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef _AKODE_LOCALFILE_H
#define _AKODE_LOCALFILE_H

#include "file.h"
#include "akode_export.h"
namespace aKode {

//! An implementation of the File interface for local-file access

/*!
 * LocalFile uses the ordinary system-interfaces for file-access, and is
 * thus capable of both reading, writing and seeking.
 */
class AKODE_EXPORT LocalFile : public File {
    int _fd;
    long pos;
    long len;
    bool m_readable;
    bool m_writeable;
    bool m_eof;
public:
    LocalFile(const char* filename);
    virtual ~LocalFile();

    bool openRO();
    bool openRW();
    bool openWO();
    void close();

    long read(char* ptr, long num);
    long write(const char* ptr, long num);

    bool seek(long to, int whence = SEEK_SET);
    long position() const;
    long length() const;

    bool seekable() const { return true; };
    bool readable() const { return m_readable; };
    bool writeable() const { return m_writeable; };

    bool error() const;
    bool eof() const;

    void fadvise();

    int fd() const;
};

} //namespace

#endif