src/autoreplace_base.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file autoreplace_base.h Base class for autoreplaces/autorenews. */
  11
  12 #ifndef AUTOREPLACE_BASE_H
  13 #define AUTOREPLACE_BASE_H
  14
  15 #include "core/pool_type.hpp"
  16 #include "autoreplace_type.h"
  17 #include "engine_type.h"
  18 #include "group_type.h"
  19
  20 typedef uint16 EngineRenewID;
  21
  22 /**
  23  * Memory pool for engine renew elements. DO NOT USE outside of engine.c. Is
  24  * placed here so the only exception to this rule, the saveload code, can use
  25  * it.
  26  */
  27 typedef Pool<EngineRenew, EngineRenewID, 16, 64000> EngineRenewPool;
  28 extern EngineRenewPool _enginerenew_pool;
  29
  30 /**
  31  * Struct to store engine replacements. DO NOT USE outside of engine.c. Is
  32  * placed here so the only exception to this rule, the saveload code, can use
  33  * it.
  34  */
  35 struct EngineRenew : EngineRenewPool::PoolItem<&_enginerenew_pool> {
  36         EngineID from;
  37         EngineID to;
  38         EngineRenew *next;
  39         GroupID group_id;
  40
  41         EngineRenew(EngineID from = INVALID_ENGINE, EngineID to = INVALID_ENGINE) : from(from), to(to) {}
  42         ~EngineRenew() {}
  43 };
  44
  45 #define FOR_ALL_ENGINE_RENEWS_FROM(var, start) FOR_ALL_ITEMS_FROM(EngineRenew, enginerenew_index, var, start)
  46 #define FOR_ALL_ENGINE_RENEWS(var) FOR_ALL_ENGINE_RENEWS_FROM(var, 0)
  47
  48 #endif /* AUTOREPLACE_BASE_H */