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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef GAMELOG_INTERNAL_H
#define GAMELOG_INTERNAL_H
 
#include "gamelog.h"
#include "openttd.h"
#include "landscape_type.h"

struct GRFPresence {
  const GRFConfig *gc = nullptr; 
  bool was_missing = false; 

  GRFPresence(const GRFConfig *gc) : gc(gc) {}

  GRFPresence() = default;
};
using GrfIDMapping = std::map<GrfID, GRFPresence>; 

struct LoggedChange {
  LoggedChange(GamelogChangeType type = GamelogChangeType::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(GamelogChangeType::Mode) {}

  LoggedChangeMode(GameMode mode, LandscapeType landscape) :
    LoggedChange(GamelogChangeType::Mode), mode(mode), landscape(landscape) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  GameMode mode{}; 
  LandscapeType landscape{}; 
};

struct LoggedChangeRevision : LoggedChange {
  LoggedChangeRevision() : LoggedChange(GamelogChangeType::Revision) {}

  LoggedChangeRevision(const std::string &text, uint32_t newgrf, uint16_t slver, uint8_t modified) :
    LoggedChange(GamelogChangeType::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 = 0; 
  uint16_t slver = 0; 
  uint8_t modified = 0; 
};

struct LoggedChangeOldVersion : LoggedChange {
  LoggedChangeOldVersion() : LoggedChange(GamelogChangeType::OldVer) {}

  LoggedChangeOldVersion(uint32_t type, uint32_t version) :
    LoggedChange(GamelogChangeType::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 = 0; 
  uint32_t version = 0; 
};

struct LoggedChangeGRFAdd : LoggedChange, GRFIdentifier {
  LoggedChangeGRFAdd() : LoggedChange(GamelogChangeType::GRFAdd) {}

  LoggedChangeGRFAdd(const GRFIdentifier &ident) :
    LoggedChange(GamelogChangeType::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(GamelogChangeType::GRFRem) {}

  LoggedChangeGRFRemoved(GrfID grfid) :
    LoggedChange(GamelogChangeType::GRFRem), grfid(grfid) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  GrfID grfid{}; 
};

struct LoggedChangeGRFChanged : LoggedChange, GRFIdentifier {
  LoggedChangeGRFChanged() : LoggedChange(GamelogChangeType::GRFCompat) {}

  LoggedChangeGRFChanged(const GRFIdentifier &ident) :
    LoggedChange(GamelogChangeType::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(GamelogChangeType::GRFParam) {}

  LoggedChangeGRFParameterChanged(GrfID grfid) :
    LoggedChange(GamelogChangeType::GRFParam), grfid(grfid) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  GrfID grfid{}; 
};

struct LoggedChangeGRFMoved : LoggedChange {
  LoggedChangeGRFMoved() : LoggedChange(GamelogChangeType::GRFMove) {}

  LoggedChangeGRFMoved(GrfID grfid, int32_t offset) :
    LoggedChange(GamelogChangeType::GRFMove), grfid(grfid), offset(offset) {}
  void FormatTo(std::back_insert_iterator<std::string> &output_iterator, GrfIDMapping &grf_names, GamelogActionType action_type) override;
 
  GrfID grfid{}; 
  int32_t offset = 0; 
};

struct LoggedChangeSettingChanged : LoggedChange {
  LoggedChangeSettingChanged() : LoggedChange(GamelogChangeType::Setting) {}

  LoggedChangeSettingChanged(const std::string &name, int32_t oldval, int32_t newval) :
    LoggedChange(GamelogChangeType::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 = 0; 
  int32_t newval = 0; 
};

struct LoggedChangeGRFBug : LoggedChange {
  LoggedChangeGRFBug() : LoggedChange(GamelogChangeType::GRFBug) {}

  LoggedChangeGRFBug(uint64_t data, GrfID grfid, GRFBug bug) :
    LoggedChange(GamelogChangeType::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 = 0; 
  GrfID grfid{}; 
  GRFBug bug{}; 
};

struct LoggedChangeEmergencySave : LoggedChange {
  LoggedChangeEmergencySave() : LoggedChange(GamelogChangeType::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 = 0; 
};

struct GamelogInternalData {
  std::vector<LoggedAction> action; 
};
 
#endif /* GAMELOG_INTERNAL_H */