summaryrefslogtreecommitdiffstats
path: root/include/svtools/filechangedchecker.hxx
blob: d50fea631a924f19690a34456fff50a6491f6480 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#pragma once

#include <svtools/svtdllapi.h>

#include <osl/time.h>
#include <rtl/ustring.hxx>
#include <vcl/timer.hxx>

#include <functional>

/** Periodically checks if a file has been modified

    Instances of this class setup a vcl timer to occasionally wake up
    check whether file modification time has changed.
 */
class SVT_DLLPUBLIC FileChangedChecker
{
private:
    Timer                    mTimer;
    OUString                 mFileName;
    TimeValue                mLastModTime;
    ::std::function<void ()> mpCallback;

    bool SVT_DLLPRIVATE getCurrentModTime(TimeValue& o_rValue) const;
    DECL_DLLPRIVATE_LINK(TimerHandler, Timer *, void);

public:
    void resetTimer();
    // bUpdate = true  when file has changed, get the return and the object get the new time
    //         = false when file has changed, only get the return, not change the object
    bool hasFileChanged(bool bUpdate = true);
    FileChangedChecker(const OUString& rFilename,
            const ::std::function<void ()>& rCallback);
    // without Timer function
    FileChangedChecker(const OUString& rFilename);
};