File: khtml_pagecache.h

package info (click to toggle)
khtml 5.54.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 18,940 kB
  • sloc: cpp: 206,281; java: 4,060; ansic: 2,829; perl: 2,313; yacc: 1,497; python: 339; sh: 141; xml: 37; makefile: 7
file content (131 lines) | stat: -rw-r--r-- 3,472 bytes parent folder | download | duplicates (2)
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
130
131
/* This file is part of the KDE project
 *
 * Copyright (C) 2000  Waldo Bastian <bastian@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 __khtml_pagecache_h__
#define __khtml_pagecache_h__

#include <QObject>

class KHTMLPageCachePrivate;

/**
 * Singleton Object that handles a binary cache on top of
 * the http cache management of kio.
 *
 * A limited number of HTML pages are stored in this cache. This
 * cache is used for the history and operations like "view source".
 * These operations always want to use the original document and
 * don't want to fetch the data from the network again.
 *
 * It operates completely independent from the kio_http cache.
 */
class KHTMLPageCache : public QObject
{
    Q_OBJECT
public:
    /**
     * static "constructor".
     * @return returns a pointer to the cache, if it exists.
     * creates a new cache otherwise.
     */
    static KHTMLPageCache *self();
    ~KHTMLPageCache();

    /**
     * Create a new cache entry.
     *
     * @return a cache entry ID is returned.
     */
    long createCacheEntry();

    /**
     * Add @p data to the cache entry with id @p id.
     */
    void addData(long id, const QByteArray &data);

    /**
     * Signal end of data for the cache entry with id @p id.
     * After calling this the entry is marked complete
     */
    void endData(long id);

    /**
     * Cancel the entry.
     */
    void cancelEntry(long id);

    /**
     * @return true when the cache entry with id @p is still valid,
     * and at least some of the data is available for reading (the
     * complete data may not yet be loaded)
     */
    bool isValid(long id);

    /**
     * @return true when the cache entry with id @p is still valid,
     * and the complete data is available for reading
     */
    bool isComplete(long id);

    /**
     * Fetch data for cache entry @p id and send it to slot @p recvSlot
     * in the object @p recvObj
     */
    void fetchData(long id, QObject *recvObj, const char *recvSlot);

    /**
     * Cancel sending data to @p recvObj
     */
    void cancelFetch(QObject *recvObj);

public Q_SLOTS:
    /**
     * Save the data of cache entry @p id to the datastream @p str
     */
    void saveData(long id, QDataStream *str);

private Q_SLOTS:
    void sendData();

private:
    KHTMLPageCache();

    KHTMLPageCachePrivate *const d;

    friend class KHTMLPageCacheSingleton;
};

class QIODevice;
class KHTMLPageCacheDelivery : public QObject
{
    friend class KHTMLPageCache;
    Q_OBJECT
public:
    KHTMLPageCacheDelivery(QIODevice *_file): file(_file) {}
    ~KHTMLPageCacheDelivery();

Q_SIGNALS:
    void emitData(const QByteArray &data);

public:
    QObject *recvObj;
    QIODevice *file;
};

#endif