company_manager_face.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 COMPANY_MANAGER_FACE_H
#define COMPANY_MANAGER_FACE_H
 
#include "core/random_func.hpp"
#include "core/bitmath_func.hpp"
#include "strings_type.h"
#include "company_type.h"
#include "gfx_type.h"

enum class FaceVarType : uint8_t {
  Sprite, 
  Palette, 
  Toggle, 
};

struct FaceVar {
  FaceVarType type; 
  uint8_t position; 
  uint8_t offset; 
  uint8_t length; 
  uint8_t valid_values; 
  std::variant<SpriteID, uint64_t, std::pair<uint64_t, uint64_t>> data; 
  StringID name{}; 

  inline uint GetBits(const CompanyManagerFace &cmf) const
  {
    return GB(cmf.bits, this->offset, this->length);
  }

  inline void SetBits(CompanyManagerFace &cmf, uint val) const
  {
    SB(cmf.bits, this->offset, this->length, val);
  }

  inline void ChangeBits(CompanyManagerFace &cmf, int8_t amount) const
  {
    int8_t val = this->GetBits(cmf) + amount; // the new value for the cmfv
 
    /* scales the new value to the correct scope */
    while (val < 0) {
      val += this->valid_values;
    }
    val %= this->valid_values;
 
    this->SetBits(cmf, val); // save the new value
  }

  inline bool IsValid(const CompanyManagerFace &cmf) const
  {
    return GB(cmf.bits, this->offset, this->length) < this->valid_values;
  }

  inline uint ScaleBits(uint val) const
  {
    assert(val < (1U << this->length));
    return (val * this->valid_values) >> this->length;
  }

  inline SpriteID GetSprite(const CompanyManagerFace &cmf) const
  {
    assert(this->type == FaceVarType::Sprite);
    return std::get<SpriteID>(this->data) + this->GetBits(cmf);
  }
};
 
using FaceVars = std::span<const FaceVar>;
 
struct FaceSpec {
  std::string label;
  std::variant<FaceVars, std::vector<FaceVar>> face_vars;
 
  inline FaceVars GetFaceVars() const
  {
    struct visitor {
      FaceVars operator()(FaceVars vars) const { return vars; }
      FaceVars operator()(const std::vector<FaceVar> &vars) const { return vars; }
    };
    return std::visit(visitor{}, this->face_vars);
  }
};
 
void ResetFaces();
uint GetNumCompanyManagerFaceStyles();
std::optional<uint> FindCompanyManagerFaceLabel(std::string_view label);
const FaceSpec *GetCompanyManagerFaceSpec(uint style_index);
FaceVars GetCompanyManagerFaceVars(uint style_index);

inline uint64_t GetActiveFaceVars(const CompanyManagerFace &cmf, FaceVars vars)
{
  uint64_t active_vars = (1ULL << std::size(vars)) - 1ULL;
 
  for (const auto &info : vars) {
    if (info.type != FaceVarType::Toggle) continue;
    const auto &[off, on] = std::get<std::pair<uint64_t, uint64_t>>(info.data);
    active_vars &= ~(HasBit(cmf.bits, info.offset) ? on : off);
  }
 
  return active_vars;
}

inline void ScaleAllCompanyManagerFaceBits(CompanyManagerFace &cmf, FaceVars vars)
{
  for (auto var : SetBitIterator(GetActiveFaceVars(cmf, vars))) {
    vars[var].ChangeBits(cmf, 0);
  }
}

inline void RandomiseCompanyManagerFaceBits(CompanyManagerFace &cmf, FaceVars vars, Randomizer &randomizer)
{
  cmf.bits = randomizer.Next();
  ScaleAllCompanyManagerFaceBits(cmf, vars);
}
 
void SetCompanyManagerFaceStyle(CompanyManagerFace &cmf, uint style);
void RandomiseCompanyManagerFace(CompanyManagerFace &cmf, Randomizer &randomizer);
uint32_t MaskCompanyManagerFaceBits(const CompanyManagerFace &cmf, FaceVars vars);
std::string FormatCompanyManagerFaceCode(const CompanyManagerFace &cmf);
std::optional<CompanyManagerFace> ParseCompanyManagerFaceCode(std::string_view str);
 
void DrawCompanyManagerFace(const CompanyManagerFace &cmf, Colours colour, const Rect &r);
 
#endif /* COMPANY_MANAGER_FACE_H */