gamelog.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GAMELOG_H
#define GAMELOG_H
 
#include "newgrf_config.h"
 
enum GamelogActionType : uint8_t {
  GLAT_START,        
  GLAT_LOAD,         
  GLAT_GRF,          
  GLAT_CHEAT,        
  GLAT_SETTING,      
  GLAT_GRFBUG,       
  GLAT_EMERGENCY,    
  GLAT_END,          
  GLAT_NONE  = 0xFF, 
};
 
enum GamelogChangeType : uint8_t {
  GLCT_MODE,        
  GLCT_REVISION,    
  GLCT_OLDVER,      
  GLCT_SETTING,     
  GLCT_GRFADD,      
  GLCT_GRFREM,      
  GLCT_GRFCOMPAT,   
  GLCT_GRFPARAM,    
  GLCT_GRFMOVE,     
  GLCT_GRFBUG,      
  GLCT_EMERGENCY,   
  GLCT_END,         
  GLCT_NONE = 0xFF, 
};
 
struct LoggedChange;
struct LoggedAction;
struct GamelogInternalData;
 
class Gamelog {
private:
  std::unique_ptr<GamelogInternalData> data;
  GamelogActionType action_type;
  struct LoggedAction *current_action;
 
  void Change(std::unique_ptr<LoggedChange> &&change);
 
public:
  Gamelog();
  ~Gamelog();
 
  void StartAction(GamelogActionType at);
  void StopAction();
  void StopAnyAction();
 
  void Reset();
 
  void Print(std::function<void(const std::string &)> proc);
  void PrintDebug(int level);
  void PrintConsole();
 
  void Emergency();
  bool TestEmergency();
 
  void Revision();
  void Mode();
  void Oldver();
  void Setting(const std::string &name, int32_t oldval, int32_t newval);
 
  void GRFUpdate(const GRFConfig *oldg, const GRFConfig *newg);
  void GRFAddList(const GRFConfig *newg);
  void GRFRemove(uint32_t grfid);
  void GRFAdd(const GRFConfig *newg);
  void GRFBug(uint32_t grfid, uint8_t bug, uint64_t data);
  bool GRFBugReverse(uint32_t grfid, uint16_t internal_id);
  void GRFCompatible(const GRFIdentifier *newg);
  void GRFMove(uint32_t grfid, int32_t offset);
  void GRFParameters(uint32_t grfid);
 
  void TestRevision();
  void TestMode();
 
  void Info(uint32_t *last_ottd_rev, uint8_t *ever_modified, bool *removed_newgrfs);
  const GRFIdentifier *GetOverriddenIdentifier(const GRFConfig *c);
 
  /* Saveload handler for gamelog needs access to internal data. */
  friend struct GLOGChunkHandler;
};
 
extern Gamelog _gamelog;
 
#endif /* GAMELOG_H */