summaryrefslogtreecommitdiffstats
path: root/Source/cmFileTimeComparison.h
blob: cc321f0d211cdc795d2bf7cee1824b16c16046e4 (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
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing for details.  */
#ifndef cmFileTimeComparison_h
#define cmFileTimeComparison_h

#include "cmConfigure.h" // IWYU pragma: keep

#include "cmFileTime.h"
#include <string>

class cmFileTimeComparisonInternal;

/** \class cmFileTimeComparison
 * \brief Caches file modification times in an internal map for fast lookups.
 */
class cmFileTimeComparison
{
public:
  cmFileTimeComparison();
  ~cmFileTimeComparison();

  cmFileTimeComparison(const cmFileTimeComparison&) = delete;
  cmFileTimeComparison& operator=(const cmFileTimeComparison&) = delete;

  /**
   * @brief Loads the file time from the cache or the file system.
   * @return true on success
   */
  bool Load(std::string const& fileName, cmFileTime& fileTime);

  /**
   * @brief Compare file modification times.
   * @return true for successful comparison and false for error.
   *
   * When true is returned, result has -1, 0, +1 for
   * f1 older, same, or newer than f2.
   */
  bool FileTimeCompare(std::string const& f1, std::string const& f2,
                       int* result);

  /**
   * @brief Compare file modification times.
   * @return true unless both files exist and have modification times less
   *         than 1 second apart.
   */
  bool FileTimesDiffer(std::string const& f1, std::string const& f2);

protected:
  cmFileTimeComparisonInternal* Internals;
};

#endif