gamelog_internal.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_INTERNAL_H
#define GAMELOG_INTERNAL_H
 
#include "gamelog.h"
#include "landscape_type.h"
 
struct GRFPresence {
  const GRFConfig *gc;  
  bool was_missing;     
 
  GRFPresence(const GRFConfig *gc) : gc(gc), was_missing(false) {}
  GRFPresence() = default;
};
using GrfIDMapping = std::map<uint32_t, GRFPresence>;
 
struct LoggedChange {
  LoggedChange(GamelogChangeType type = GLCT_NONE) : ct(type) {}
  virtual ~LoggedChange() = default;
  virtual void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) = 0;
 
  GamelogChangeType ct;
};
 
struct LoggedChangeMode : LoggedChange {
  LoggedChangeMode() : LoggedChange(GLCT_MODE) {}
  LoggedChangeMode(uint8_t mode, LandscapeType landscape) :
    LoggedChange(GLCT_MODE), mode(mode), landscape(landscape) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  uint8_t mode;      
  LandscapeType landscape; 
};
 
struct LoggedChangeRevision : LoggedChange {
  LoggedChangeRevision() : LoggedChange(GLCT_REVISION) {}
  LoggedChangeRevision(const std::string &text, uint32_t newgrf, uint16_t slver, uint8_t modified) :
    LoggedChange(GLCT_REVISION), text(text), newgrf(newgrf), slver(slver), modified(modified) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  std::string text; 
  uint32_t newgrf;  
  uint16_t slver;   
  uint8_t modified;    //< _openttd_revision_modified
};
 
struct LoggedChangeOldVersion : LoggedChange {
  LoggedChangeOldVersion() : LoggedChange(GLCT_OLDVER) {}
  LoggedChangeOldVersion(uint32_t type, uint32_t version) :
    LoggedChange(GLCT_OLDVER), type(type), version(version) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  uint32_t type;    
  uint32_t version; 
};
 
struct LoggedChangeGRFAdd : LoggedChange, GRFIdentifier {
  LoggedChangeGRFAdd() : LoggedChange(GLCT_GRFADD) {}
  LoggedChangeGRFAdd(const GRFIdentifier &ident) :
    LoggedChange(GLCT_GRFADD), GRFIdentifier(ident) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
};
 
struct LoggedChangeGRFRemoved : LoggedChange {
  LoggedChangeGRFRemoved() : LoggedChange(GLCT_GRFREM) {}
  LoggedChangeGRFRemoved(uint32_t grfid) :
    LoggedChange(GLCT_GRFREM), grfid(grfid) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  uint32_t grfid; 
};
 
struct LoggedChangeGRFChanged : LoggedChange, GRFIdentifier {
  LoggedChangeGRFChanged() : LoggedChange(GLCT_GRFCOMPAT) {}
  LoggedChangeGRFChanged(const GRFIdentifier &ident) :
    LoggedChange(GLCT_GRFCOMPAT), GRFIdentifier(ident) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
};
 
struct LoggedChangeGRFParameterChanged : LoggedChange {
  LoggedChangeGRFParameterChanged() : LoggedChange(GLCT_GRFPARAM) {}
  LoggedChangeGRFParameterChanged(uint32_t grfid) :
    LoggedChange(GLCT_GRFPARAM), grfid(grfid) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  uint32_t grfid; 
};
 
struct LoggedChangeGRFMoved : LoggedChange {
  LoggedChangeGRFMoved() : LoggedChange(GLCT_GRFMOVE) {}
  LoggedChangeGRFMoved(uint32_t grfid, int32_t offset) :
    LoggedChange(GLCT_GRFMOVE), grfid(grfid), offset(offset) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  uint32_t grfid; 
  int32_t offset; 
};
 
struct LoggedChangeSettingChanged : LoggedChange {
  LoggedChangeSettingChanged() : LoggedChange(GLCT_SETTING) {}
  LoggedChangeSettingChanged(const std::string &name, int32_t oldval, int32_t newval) :
    LoggedChange(GLCT_SETTING), name(name), oldval(oldval), newval(newval) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  std::string name; 
  int32_t oldval;   
  int32_t newval;   
};
 
struct LoggedChangeGRFBug : LoggedChange {
  LoggedChangeGRFBug() : LoggedChange(GLCT_GRFBUG) {}
  LoggedChangeGRFBug(uint64_t data, uint32_t grfid, GRFBug bug) :
    LoggedChange(GLCT_GRFBUG), data(data), grfid(grfid), bug(bug) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  uint64_t data;  
  uint32_t grfid; 
  GRFBug bug; 
};
 
struct LoggedChangeEmergencySave : LoggedChange {
  LoggedChangeEmergencySave() : LoggedChange(GLCT_EMERGENCY) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
};
 
 
struct LoggedAction {
  std::vector<std::unique_ptr<LoggedChange>> change; 
  GamelogActionType at; 
  uint64_t tick;        
};
 
struct GamelogInternalData {
  std::vector<LoggedAction> action;
};
 
#endif /* GAMELOG_INTERNAL_H */