lllivefile.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:3k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lllivefile.h
  3.  * @brief Automatically reloads a file whenever it changes or is removed.
  4.  *
  5.  * $LicenseInfo:firstyear=2006&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2006-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLLIVEFILE_H
  33. #define LL_LLLIVEFILE_H
  34. extern const F32 DEFAULT_CONFIG_FILE_REFRESH;
  35. class LL_COMMON_API LLLiveFile
  36. {
  37. public:
  38. LLLiveFile(const std::string& filename, const F32 refresh_period = 5.f);
  39. virtual ~LLLiveFile();
  40. /**
  41.  * @brief Check to see if this live file should reload.
  42.  *
  43.  * Call this before using anything that was read & cached
  44.  * from the file.
  45.  *
  46.  * This method calls the <code>loadFile()</code> method if
  47.  * any of:
  48.  *   file has a new modify time since the last check
  49.  *   file used to exist and now does not
  50.  *   file used to not exist but now does
  51.  * @return Returns true if the file was reloaded.
  52.  */
  53. bool checkAndReload();
  54. std::string filename() const;
  55. /**
  56.  * @brief Add this live file to an automated recheck.
  57.  *
  58.  * Normally, just calling checkAndReload() is enough. In some
  59.  * cases though, you may need to let the live file periodically
  60.  * check itself.
  61.  */
  62. void addToEventTimer();
  63. void setRefreshPeriod(F32 seconds);
  64. protected:
  65. /**
  66.  * @breif Implement this to load your file if it changed.
  67.  *
  68.  * This method is called automatically by <code>checkAndReload()</code>,
  69.  * so though you must implement this in derived classes, you do
  70.  * not need to call it manually.
  71.  * @return Returns true if the file was successfully loaded.
  72.  */
  73. virtual bool loadFile() = 0;
  74. /**
  75.  * @brief Implement this method if you want to get a change callback.
  76.  *
  77.  * This virtual function will be called automatically at the end
  78.  * of <code>checkAndReload()</code> if a new configuration was
  79.  * loaded. This does not track differences between the current and
  80.  * newly loaded file, so any successful load event will trigger a
  81.  * <code>changed()</code> callback. Default is to do nothing.
  82.  */
  83. virtual void changed() {}
  84. private:
  85. class Impl;
  86. Impl& impl;
  87. };
  88. #endif //LL_LLLIVEFILE_H