src/signal.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 signal.h Types and classes related to signals. */
  11
  12 #ifndef SIGNAL_H
  13 #define SIGNAL_H
  14
  15 #include "core/enum_type.hpp"
  16
  17 /** Variant of the signal, i.e. how does the signal look? */
  18 enum SignalVariant {
  19         SIG_ELECTRIC  = 0, ///< Light signal
  20         SIG_SEMAPHORE = 1, ///< Old-fashioned semaphore signal
  21 };
  22
  23
  24 /** Type of signal, i.e. how does the signal behave? */
  25 enum SignalType {
  26         SIGTYPE_NORMAL     = 0, ///< normal signal
  27         SIGTYPE_ENTRY      = 1, ///< presignal block entry
  28         SIGTYPE_EXIT       = 2, ///< presignal block exit
  29         SIGTYPE_COMBO      = 3, ///< presignal inter-block
  30         SIGTYPE_PBS        = 4, ///< normal pbs signal
  31         SIGTYPE_PBS_ONEWAY = 5, ///< no-entry signal
  32         SIGTYPE_END,
  33 };
  34 /** Helper information for extract tool. */
  35 template <> struct EnumPropsT<SignalType> : MakeEnumPropsT<SignalType, byte, SIGTYPE_NORMAL, SIGTYPE_END, SIGTYPE_END, 3> {};
  36
  37
  38 /**
  39  * These are states in which a signal can be. Currently these are only two, so
  40  * simple boolean logic will do. But do try to compare to this enum instead of
  41  * normal boolean evaluation, since that will make future additions easier.
  42  */
  43 enum SignalState {
  44         SIGNAL_STATE_RED   = 0, ///< The signal is red
  45         SIGNAL_STATE_GREEN = 1, ///< The signal is green
  46 };
  47
  48
  49 static inline bool IsPbsSignal(SignalType s)
  50 {
  51         return s >= SIGTYPE_PBS;
  52 }
  53
  54 static inline bool IsPresignalEntry(SignalType s)
  55 {
  56         return s == SIGTYPE_ENTRY || s == SIGTYPE_COMBO;
  57 }
  58
  59 static inline bool IsPresignalExit(SignalType s)
  60 {
  61         return s == SIGTYPE_EXIT || s == SIGTYPE_COMBO;
  62 }
  63
  64 /** One-way signals can't be passed the 'wrong' way. */
  65 static inline bool IsOnewaySignal(SignalType s)
  66 {
  67         return s != SIGTYPE_PBS;
  68 }
  69
  70 #endif /* SIGNAL_H */