File: modificationrevision.cpp

package info (click to toggle)
kdevelop 4%3A22.12.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 70,096 kB
  • sloc: cpp: 284,635; javascript: 3,558; python: 3,422; sh: 1,319; ansic: 685; xml: 331; php: 95; lisp: 66; makefile: 39; sed: 12
file content (152 lines) | stat: -rw-r--r-- 4,593 bytes parent folder | download
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
    SPDX-FileCopyrightText: 2008 David Nolden <david.nolden.kdevelop@art-master.de>

    SPDX-License-Identifier: LGPL-2.0-only
*/

#include "modificationrevision.h"

#include <QString>
#include <QFileInfo>
#include <QMutex>
#include <QMutexLocker>

#include <serialization/indexedstring.h>
#include "modificationrevisionset.h"

/// @todo Listen to filesystem changes (together with the project manager)
/// and call fileModificationCache().clear(...) when a file has changed

const int KDevelop::cacheModificationTimesForSeconds = 30;

using namespace KDevelop;
namespace
{
struct FileModificationCache
{
    QDateTime m_readTime;
    QDateTime m_modificationTime;
};
}
Q_DECLARE_TYPEINFO(FileModificationCache, Q_MOVABLE_TYPE);

namespace
{
using FileModificationMap = QHash<IndexedString, FileModificationCache>;
using OpenDocumentRevisionsMap = QHash<IndexedString, int>;

// data protected by the mutex in the StaticCacheData below
struct CacheData {
    FileModificationMap fileModificationCache;
    OpenDocumentRevisionsMap openRevisionsCache;

    QDateTime fileModificationTimeCached(const IndexedString& fileName)
    {
        const auto currentTime = QDateTime::currentDateTimeUtc();

        auto it = fileModificationCache.constFind(fileName);
        if (it != fileModificationCache.constEnd()) {
            /// Use the cache for X seconds
            if (it.value().m_readTime.secsTo(currentTime) < cacheModificationTimesForSeconds) {
                return it.value().m_modificationTime;
            }
        }

        QFileInfo fileInfo(fileName.str());
        FileModificationCache data = { currentTime, fileInfo.lastModified() };
        fileModificationCache.insert(fileName, data);
        return data.m_modificationTime;
    }

    ModificationRevision revisionForFile(const IndexedString& url)
    {
        ModificationRevision ret(fileModificationTimeCached(url));

        OpenDocumentRevisionsMap::const_iterator it = openRevisionsCache.constFind(url);
        if (it != openRevisionsCache.constEnd()) {
            ret.revision = it.value();
        }

        return ret;
    }
};

// protects CacheData with a mutex and only allows thread safe access
class StaticCacheData
{
public:
    template <typename Op>
    auto op(Op&& op)
    {
        QMutexLocker lock(&m_mutex);
        return op(m_cacheData);
    }

private:
    QMutex m_mutex;
    CacheData m_cacheData;
};

StaticCacheData& cacheData()
{
    static StaticCacheData cacheData;
    return cacheData;
}
}

void ModificationRevision::clearModificationCache(const IndexedString& fileName)
{
    ///@todo Make the cache management more clever (don't clear the whole)
    ModificationRevisionSet::clearCache();

    cacheData().op([&fileName](CacheData& data) { data.fileModificationCache.remove(fileName); });
}

ModificationRevision ModificationRevision::revisionForFile(const IndexedString& url)
{
    return cacheData().op([&url](CacheData& data) { return data.revisionForFile(url); });
}

void ModificationRevision::clearEditorRevisionForFile(const IndexedString& url)
{
    ModificationRevisionSet::clearCache(); ///@todo Make the cache management more clever (don't clear the whole)

    return cacheData().op([&url](CacheData& data) { data.openRevisionsCache.remove(url); });
}

void ModificationRevision::setEditorRevisionForFile(const IndexedString& url, int revision)
{
    ModificationRevisionSet::clearCache(); ///@todo Make the cache management more clever (don't clear the whole)

    return cacheData().op([&url, revision](CacheData& data) {
        data.openRevisionsCache.insert(url, revision);
        Q_ASSERT(data.revisionForFile(url).revision == revision);
    });
}

ModificationRevision::ModificationRevision(const QDateTime& modTime, int revision_)
    : modificationTime(modTime.toSecsSinceEpoch())
    , revision(revision_)
{
}

bool ModificationRevision::operator <(const ModificationRevision& rhs) const
{
    return modificationTime < rhs.modificationTime ||
           (modificationTime == rhs.modificationTime && revision < rhs.revision);
}

bool ModificationRevision::operator ==(const ModificationRevision& rhs) const
{
    return modificationTime == rhs.modificationTime && revision == rhs.revision;
}

bool ModificationRevision::operator !=(const ModificationRevision& rhs) const
{
    return modificationTime != rhs.modificationTime || revision != rhs.revision;
}

QString ModificationRevision::toString() const
{
    return QStringLiteral("%1 (rev %2)").arg(QDateTime::fromSecsSinceEpoch(modificationTime, Qt::LocalTime).time().toString()).arg(revision);
}