bjarni@2676: /* $Id$ */
bjarni@2676: 
celestar@9908: /** @file train.h */
celestar@9908: 
bjarni@2676: #ifndef TRAIN_H
bjarni@2676: #define TRAIN_H
bjarni@2676: 
bjarni@2676: #include "stdafx.h"
bjarni@2676: #include "vehicle.h"
bjarni@2676: 
bjarni@2676: 
bjarni@2676: /*
bjarni@2676:  * enum to handle train subtypes
bjarni@2676:  * Do not access it directly unless you have to. Use the access functions below
bjarni@2676:  * This is an enum to tell what bit to access as it is a bitmask
bjarni@2676:  */
bjarni@2676: 
celestar@9895: enum TrainSubtype {
celestar@9908: 	Train_Front             = 0, ///< Leading engine of a train
celestar@9908: 	Train_Articulated_Part  = 1, ///< Articulated part of an engine
celestar@9908: 	Train_Wagon             = 2, ///< Wagon
celestar@9908: 	Train_Engine            = 3, ///< Engine, that can be front engines, but might be placed behind another engine
celestar@9908: 	Train_Free_Wagon        = 4, ///< First in a wagon chain (in depot)
celestar@9908: 	Train_Multiheaded       = 5, ///< Engine is a multiheaded
celestar@9895: };
bjarni@2676: 
bjarni@2676: 
bjarni@2676: /** Check if a vehicle is front engine
bjarni@2676:  * @param v vehicle to check
bjarni@2676:  * @return Returns true if vehicle is a front engine
bjarni@2676:  */
bjarni@2676: static inline bool IsFrontEngine(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return HASBIT(v->subtype, Train_Front);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Set front engine state
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void SetFrontEngine(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	SETBIT(v->subtype, Train_Front);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Remove the front engine state
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void ClearFrontEngine(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	CLRBIT(v->subtype, Train_Front);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Check if a vehicle is an articulated part of an engine
bjarni@2676:  * @param v vehicle to check
bjarni@2676:  * @return Returns true if vehicle is an articulated part
bjarni@2676:  */
bjarni@2676: static inline bool IsArticulatedPart(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return HASBIT(v->subtype, Train_Articulated_Part);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Set a vehicle to be an articulated part
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void SetArticulatedPart(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	SETBIT(v->subtype, Train_Articulated_Part);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Clear a vehicle from being an articulated part
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void ClearArticulatedPart(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	CLRBIT(v->subtype, Train_Articulated_Part);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Check if a vehicle is a wagon
bjarni@2676:  * @param v vehicle to check
bjarni@2676:  * @return Returns true if vehicle is a wagon
bjarni@2676:  */
bjarni@2676: static inline bool IsTrainWagon(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return HASBIT(v->subtype, Train_Wagon);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Set a vehicle to be a wagon
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void SetTrainWagon(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	SETBIT(v->subtype, Train_Wagon);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Clear wagon property
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void ClearTrainWagon(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	CLRBIT(v->subtype, Train_Wagon);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Check if a vehicle is an engine (can be first in a train)
bjarni@2676:  * @param v vehicle to check
bjarni@2676:  * @return Returns true if vehicle is an engine
bjarni@2676:  */
bjarni@2676: static inline bool IsTrainEngine(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return HASBIT(v->subtype, Train_Engine);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Set engine status
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void SetTrainEngine(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	SETBIT(v->subtype, Train_Engine);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Clear engine status
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void ClearTrainEngine(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	CLRBIT(v->subtype, Train_Engine);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Check if a vehicle is a free wagon (got no engine in front of it)
bjarni@2676:  * @param v vehicle to check
bjarni@2676:  * @return Returns true if vehicle is a free wagon
bjarni@2676:  */
bjarni@2676: static inline bool IsFreeWagon(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return HASBIT(v->subtype, Train_Free_Wagon);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Set if a vehicle is a free wagon
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void SetFreeWagon(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	SETBIT(v->subtype, Train_Free_Wagon);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Clear a vehicle from being a free wagon
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void ClearFreeWagon(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	CLRBIT(v->subtype, Train_Free_Wagon);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Check if a vehicle is a multiheaded engine
bjarni@2676:  * @param v vehicle to check
bjarni@2676:  * @return Returns true if vehicle is a multiheaded engine
bjarni@2676:  */
bjarni@2676: static inline bool IsMultiheaded(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return HASBIT(v->subtype, Train_Multiheaded);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Set if a vehicle is a multiheaded engine
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void SetMultiheaded(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	SETBIT(v->subtype, Train_Multiheaded);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Clear multiheaded engine property
bjarni@2676:  * @param v vehicle to change
bjarni@2676:  */
bjarni@2676: static inline void ClearMultiheaded(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	CLRBIT(v->subtype, Train_Multiheaded);
bjarni@2676: }
bjarni@2676: 
bjarni@2676: /** Check if an engine has an articulated part.
bjarni@2676:  * @param v Vehicle.
bjarni@2676:  * @return True if the engine has an articulated part.
bjarni@2676:  */
bjarni@2676: static inline bool EngineHasArticPart(const Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
bjarni@2676: 	return (v->next != NULL && IsArticulatedPart(v->next));
bjarni@2676: }
bjarni@2676: 
truelight@4384: /**
truelight@4384:  * Get the next part of a multi-part engine.
truelight@4384:  * Will only work on a multi-part engine (EngineHasArticPart(v) == true),
truelight@4384:  * Result is undefined for normal engine.
truelight@4384:  */
truelight@4384: static inline Vehicle *GetNextArticPart(const Vehicle *v)
truelight@4384: {
truelight@4384: 	assert(EngineHasArticPart(v));
truelight@4384: 	return v->next;
truelight@4384: }
truelight@4384: 
bjarni@2676: /** Get the last part of a multi-part engine.
bjarni@2676:  * @param v Vehicle.
bjarni@2676:  * @return Last part of the engine.
bjarni@2676:  */
bjarni@2676: static inline Vehicle *GetLastEnginePart(Vehicle *v)
bjarni@2676: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
truelight@4384: 	while (EngineHasArticPart(v)) v = GetNextArticPart(v);
bjarni@2676: 	return v;
bjarni@2676: }
bjarni@2676: 
truelight@4384: /** Get the next real (non-articulated part) vehicle in the consist.
truelight@4384:  * @param v Vehicle.
truelight@4384:  * @return Next vehicle in the consist.
truelight@4384:  */
truelight@4384: static inline Vehicle *GetNextVehicle(const Vehicle *v)
truelight@4384: {
celestar@9912: 	assert(v->type == VEH_TRAIN);
truelight@4384: 	while (EngineHasArticPart(v)) v = GetNextArticPart(v);
truelight@4384: 
truelight@4384: 	/* v now contains the last artic part in the engine */
truelight@4384: 	return v->next;
truelight@4384: }
truelight@4384: 
celestar@9895: void ConvertOldMultiheadToNew();
celestar@9895: void ConnectMultiheadedTrains();
peter1138@4737: uint CountArticulatedParts(EngineID engine_type);
bjarni@2855: 
bjarni@4648: int CheckTrainInDepot(const Vehicle *v, bool needs_to_be_stopped);
bjarni@6030: void CcBuildLoco(bool success, TileIndex tile, uint32 p1, uint32 p2);
bjarni@6030: void CcBuildWagon(bool success, TileIndex tile, uint32 p1, uint32 p2);
bjarni@4653: void CcCloneTrain(bool success, TileIndex tile, uint32 p1, uint32 p2);
bjarni@4640: 
peter1138@5316: byte FreightWagonMult(CargoID cargo);
peter1138@5163: 
celestar@9911: /**
celestar@9911:  * This class 'wraps' Vehicle; you do not actually instantiate this class.
celestar@9911:  * You create a Vehicle using AllocateVehicle, so it is added to the pool
celestar@9911:  * and you reinitialize that to a Train using:
celestar@9911:  *   v = new (v) Train();
celestar@9911:  *
celestar@9911:  * As side-effect the vehicle type is set correctly.
celestar@9911:  */
celestar@9911: struct Train : public Vehicle {
celestar@9911: 	/** Initializes the Vehicle to a train */
celestar@9911: 	Train() { this->type = VEH_TRAIN; }
celestar@9911: 
celestar@9911: 	/** We want to 'destruct' the right class. */
celestar@9911: 	virtual ~Train() {}
celestar@9911: 
celestar@9911: 	const char *GetTypeString() const { return "train"; }
celestar@9911: 	void MarkDirty();
celestar@9911: 	void UpdateDeltaXY(Direction direction);
celestar@9911: 	ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_TRAIN_INC : EXPENSES_TRAIN_RUN; }
celestar@9911: 	WindowClass GetVehicleListWindowClass() const { return WC_TRAINS_LIST; }
celestar@9911: 	void PlayLeaveStationSound() const;
celestar@9912: 	bool IsPrimaryVehicle() const { return IsFrontEngine(this); }
celestar@9912: 	bool HasFront() const { return true; }
celestar@9911: };
celestar@9911: 
bjarni@2676: #endif /* TRAIN_H */