Source/cmListFileCache.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmListFileCache.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-09-19 18:34:15 $
   7   Version:   $Revision: 1.7 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmListFileCache_h
  18 #define cmListFileCache_h
  19
  20 #include "cmStandardIncludes.h"
  21
  22 /** \class cmListFileCache
  23  * \brief A class to cache list file contents.
  24  *
  25  * cmListFileCache is a class used to cache the contents of parsed
  26  * cmake list files.
  27  */
  28
  29 struct cmListFileFunction
  30 {
  31   std::string m_Name;
  32   std::vector<std::string> m_Arguments;
  33 };
  34
  35 struct cmListFile
  36 {
  37   cmListFile()
  38     :m_ModifiedTime(0)
  39     {
  40     }
  41   long int m_ModifiedTime;
  42   std::vector<cmListFileFunction> m_Functions;
  43 };
  44
  45 class cmListFileCache
  46 {
  47 public:
  48   static cmListFileCache* GetInstance();
  49   static void ClearCache();
  50
  51
  52   /** Return the cached version of the given file.
  53    *  If the file is not already in the cache, a cache entry
  54    *  will be made.  If there is an error loading the file,
  55    *  NULL is returned.
  56    */
  57   cmListFile* GetFileCache(const char* path);
  58
  59   //! Flush cache file out of cache.
  60   void FlushCache(const char* path);
  61
  62 private:
  63   // Cache the file
  64   bool CacheFile(const char* path);
  65   // private data
  66   typedef std::map<cmStdString, cmListFile> ListFileMap;
  67   ListFileMap m_ListFileCache;  // file name to ListFile map
  68   static cmListFileCache* Instance; // singelton pointer
  69 };
  70
  71
  72 #endif