Programmable signals: Fix whitespace issues.

This commit is contained in:
Jonathan G Rennison
2015-10-03 13:36:31 +01:00
parent bc8818d9ac
commit 1823deae7d
3 changed files with 62 additions and 60 deletions

View File

@@ -428,7 +428,7 @@ void RemoveProgramDependencies(SignalReference by, SignalReference on)
} }
} }
AddTrackToSignalBuffer(by.tile, by.track, GetTileOwner(by.tile)); AddTrackToSignalBuffer(by.tile, by.track, GetTileOwner(by.tile));
UpdateSignalsInBuffer(); UpdateSignalsInBuffer();
} }

View File

@@ -33,10 +33,10 @@ struct SignalProgram {
SignalProgram(TileIndex tile, Track track, bool raw = false); SignalProgram(TileIndex tile, Track track, bool raw = false);
~SignalProgram(); ~SignalProgram();
void DebugPrintProgram(); void DebugPrintProgram();
TileIndex tile; TileIndex tile;
Track track; Track track;
SignalSpecial *first_instruction; SignalSpecial *first_instruction;
SignalSpecial *last_instruction; SignalSpecial *last_instruction;
InstructionList instructions; InstructionList instructions;
@@ -55,7 +55,7 @@ enum SignalOpcode {
PSO_IF_ELSE = 3, ///< If Else pseudo instruction PSO_IF_ELSE = 3, ///< If Else pseudo instruction
PSO_IF_ENDIF = 4, ///< If Endif pseudo instruction PSO_IF_ENDIF = 4, ///< If Endif pseudo instruction
PSO_SET_SIGNAL = 5, ///< Set signal instruction PSO_SET_SIGNAL = 5, ///< Set signal instruction
PSO_END, PSO_END,
PSO_INVALID = 0xFF PSO_INVALID = 0xFF
}; };
@@ -66,22 +66,22 @@ class SignalInstruction {
public: public:
/// Get the instruction's opcode /// Get the instruction's opcode
inline SignalOpcode Opcode() const { return this->opcode; } inline SignalOpcode Opcode() const { return this->opcode; }
/// Get the previous instruction. If this is NULL, then this is the first /// Get the previous instruction. If this is NULL, then this is the first
/// instruction. /// instruction.
inline SignalInstruction *Previous() const { return this->previous; } inline SignalInstruction *Previous() const { return this->previous; }
/// Get the Id of this instruction /// Get the Id of this instruction
inline int Id() const inline int Id() const
// Const cast is safe (perculiarity of SmallVector) // Const cast is safe (perculiarity of SmallVector)
{ return program->instructions.FindIndex(const_cast<SignalInstruction*>(this)); } { return program->instructions.FindIndex(const_cast<SignalInstruction*>(this)); }
/// Insert this instruction, placing it before @p before_insn /// Insert this instruction, placing it before @p before_insn
virtual void Insert(SignalInstruction *before_insn); virtual void Insert(SignalInstruction *before_insn);
/// Evaluate the instruction. The instruction should update the VM state. /// Evaluate the instruction. The instruction should update the VM state.
virtual void Evaluate(SignalVM &vm) = 0; virtual void Evaluate(SignalVM &vm) = 0;
/// Remove the instruction. When removing itself, an instruction should /// Remove the instruction. When removing itself, an instruction should
/// <ul> /// <ul>
/// <li>Set next->previous to previous /// <li>Set next->previous to previous
@@ -89,20 +89,20 @@ public:
/// <li>Destroy any other children /// <li>Destroy any other children
/// </ul> /// </ul>
virtual void Remove() = 0; virtual void Remove() = 0;
/// Gets a reference to the previous member. This is only intended for use by /// Gets a reference to the previous member. This is only intended for use by
/// the saveload code. /// the saveload code.
inline SignalInstruction *&GetPrevHandle() inline SignalInstruction *&GetPrevHandle()
{ return previous; } { return previous; }
/// Sets the previous instruction of this instruction. This is only intended /// Sets the previous instruction of this instruction. This is only intended
/// to be used by instructions to update links during insertion and removal. /// to be used by instructions to update links during insertion and removal.
inline void SetPrevious(SignalInstruction *prev) inline void SetPrevious(SignalInstruction *prev)
{ previous = prev; } { previous = prev; }
/// Set the next instruction. This is only intended to be used by instructions /// Set the next instruction. This is only intended to be used by instructions
/// to update links during insertion and removal /// to update links during insertion and removal
virtual void SetNext(SignalInstruction *next_insn) = 0; virtual void SetNext(SignalInstruction *next_insn) = 0;
protected: protected:
/// Constructs an instruction /// Constructs an instruction
/// @param prog the program to add this instruction to /// @param prog the program to add this instruction to
@@ -117,7 +117,7 @@ protected:
/** Programmable Signal condition code. /** Programmable Signal condition code.
* *
* These discriminate conditions in much the same way that SignalOpcode * These discriminate conditions in much the same way that SignalOpcode
* discriminates instructions. * discriminates instructions.
*/ */
enum SignalConditionCode { enum SignalConditionCode {
@@ -126,7 +126,7 @@ enum SignalConditionCode {
PSC_NUM_GREEN = 2, ///< Number of green signals behind this signal PSC_NUM_GREEN = 2, ///< Number of green signals behind this signal
PSC_NUM_RED = 3, ///< Number of red signals behind this signal PSC_NUM_RED = 3, ///< Number of red signals behind this signal
PSC_SIGNAL_STATE = 4, ///< State of another signal PSC_SIGNAL_STATE = 4, ///< State of another signal
PSC_MAX = PSC_SIGNAL_STATE PSC_MAX = PSC_SIGNAL_STATE
}; };
@@ -134,16 +134,16 @@ class SignalCondition {
public: public:
/// Get the condition's code /// Get the condition's code
inline SignalConditionCode ConditionCode() const { return this->cond_code; } inline SignalConditionCode ConditionCode() const { return this->cond_code; }
/// Evaluate the condition /// Evaluate the condition
virtual bool Evaluate(SignalVM& vm) = 0; virtual bool Evaluate(SignalVM& vm) = 0;
/// Destroy the condition. Any children should also be destroyed /// Destroy the condition. Any children should also be destroyed
virtual ~SignalCondition(); virtual ~SignalCondition();
protected: protected:
SignalCondition(SignalConditionCode code) : cond_code(code) {} SignalCondition(SignalConditionCode code) : cond_code(code) {}
const SignalConditionCode cond_code; const SignalConditionCode cond_code;
}; };
@@ -167,7 +167,7 @@ enum SignalComparator {
SGC_MORE_THAN_EQUALS = 5, ///< the variable is grater than or equal to the specified value SGC_MORE_THAN_EQUALS = 5, ///< the variable is grater than or equal to the specified value
SGC_IS_TRUE = 6, ///< the variable is true (non-zero) SGC_IS_TRUE = 6, ///< the variable is true (non-zero)
SGC_IS_FALSE = 7, ///< the variable is false (zero) SGC_IS_FALSE = 7, ///< the variable is false (zero)
SGC_LAST = SGC_IS_FALSE SGC_LAST = SGC_IS_FALSE
}; };
@@ -188,10 +188,10 @@ public:
/// Constructs a condition refering to the value @p code refers to. Sets the /// Constructs a condition refering to the value @p code refers to. Sets the
/// comparator and value to sane defaults. /// comparator and value to sane defaults.
SignalVariableCondition(SignalConditionCode code); SignalVariableCondition(SignalConditionCode code);
SignalComparator comparator; SignalComparator comparator;
uint32 value; uint32 value;
/// Evaluates the condition /// Evaluates the condition
virtual bool Evaluate(SignalVM &vm); virtual bool Evaluate(SignalVM &vm);
}; };
@@ -200,14 +200,14 @@ public:
class SignalStateCondition: public SignalCondition { class SignalStateCondition: public SignalCondition {
public: public:
SignalStateCondition(SignalReference this_sig, TileIndex sig_tile, Trackdir sig_track); SignalStateCondition(SignalReference this_sig, TileIndex sig_tile, Trackdir sig_track);
void SetSignal(TileIndex tile, Trackdir track); void SetSignal(TileIndex tile, Trackdir track);
bool IsSignalValid(); bool IsSignalValid();
void Invalidate(); void Invalidate();
virtual bool Evaluate(SignalVM& vm); virtual bool Evaluate(SignalVM& vm);
virtual ~SignalStateCondition(); virtual ~SignalStateCondition();
SignalReference this_sig; SignalReference this_sig;
TileIndex sig_tile; TileIndex sig_tile;
Trackdir sig_track; Trackdir sig_track;
@@ -223,8 +223,8 @@ class SignalStateCondition: public SignalCondition {
* <li>They permit every other instruction to assume that there is another * <li>They permit every other instruction to assume that there is another
* following it. This makes the code much simpler (and by extension less * following it. This makes the code much simpler (and by extension less
* error prone)</li> * error prone)</li>
* <li>Particularly in the case of the End instruction, they provide an * <li>Particularly in the case of the End instruction, they provide an
* instruction in the user interface that can be clicked on to add * instruction in the user interface that can be clicked on to add
* instructions at the end of a program</li> * instructions at the end of a program</li>
* </ol> * </ol>
*/ */
@@ -232,23 +232,23 @@ class SignalSpecial: public SignalInstruction {
public: public:
/** Constructs a special signal of the opcode @p op in program @p prog. /** Constructs a special signal of the opcode @p op in program @p prog.
* *
* Generally you should not need to call this; it will be called by the * Generally you should not need to call this; it will be called by the
* program's constructor. An exception is in the saveload code, which needs * program's constructor. An exception is in the saveload code, which needs
* to construct raw objects to deserialize into * to construct raw objects to deserialize into
*/ */
SignalSpecial(SignalProgram *prog, SignalOpcode op); SignalSpecial(SignalProgram *prog, SignalOpcode op);
/** Evaluates the instruction. If this is an Start instruction, flow will be /** Evaluates the instruction. If this is an Start instruction, flow will be
* vectored to the first instruction; if it is an End instruction, the program * vectored to the first instruction; if it is an End instruction, the program
* will terminate and the signal will be left red. * will terminate and the signal will be left red.
*/ */
virtual void Evaluate(SignalVM &vm); virtual void Evaluate(SignalVM &vm);
/** Links the first and last instructions in the program. Generally only to be /** Links the first and last instructions in the program. Generally only to be
* called from the SignalProgram constructor. * called from the SignalProgram constructor.
*/ */
static void link(SignalSpecial *first, SignalSpecial *last); static void link(SignalSpecial *first, SignalSpecial *last);
/** Removes this instruction. If this is the start instruction, then all of /** Removes this instruction. If this is the start instruction, then all of
* the other instructions in the program will be successively removed, * the other instructions in the program will be successively removed,
* (emptying it). If this is the End instruction, then it will do nothing. * (emptying it). If this is the End instruction, then it will do nothing.
@@ -257,12 +257,12 @@ public:
* the instruction. * the instruction.
*/ */
virtual void Remove(); virtual void Remove();
/** The next instruction after this one. On the End instruction, this should /** The next instruction after this one. On the End instruction, this should
* be NULL. * be NULL.
*/ */
SignalInstruction *next; SignalInstruction *next;
virtual void SetNext(SignalInstruction *next_insn); virtual void SetNext(SignalInstruction *next_insn);
}; };
@@ -273,12 +273,12 @@ public:
*/ */
class SignalIf: public SignalInstruction { class SignalIf: public SignalInstruction {
public: public:
/** The If-Else and If-Endif pseudo instructions. The Else instruction /** The If-Else and If-Endif pseudo instructions. The Else instruction
* follows the Then block, and the Endif instruction follows the Else block. * follows the Then block, and the Endif instruction follows the Else block.
* *
* These serve two purposes: * These serve two purposes:
* <ul> * <ul>
* <li>They correctly vector the execution to after the if block * <li>They correctly vector the execution to after the if block
* (if needed) * (if needed)
* <li>They provide an instruction for the GUI to insert other instructions * <li>They provide an instruction for the GUI to insert other instructions
* before. * before.
@@ -286,55 +286,55 @@ public:
*/ */
class PseudoInstruction: public SignalInstruction { class PseudoInstruction: public SignalInstruction {
public: public:
/** Normal constructor. The pseudo instruction will be constructed as /** Normal constructor. The pseudo instruction will be constructed as
* belonging to @p block. * belonging to @p block.
*/ */
PseudoInstruction(SignalProgram *prog, SignalIf *block, SignalOpcode op); PseudoInstruction(SignalProgram *prog, SignalIf *block, SignalOpcode op);
/** Constructs an empty instruction of type @p op. This should only be used /** Constructs an empty instruction of type @p op. This should only be used
* by the saveload code during deserialization. The instruction must have * by the saveload code during deserialization. The instruction must have
* its block field set correctly before the program is run. * its block field set correctly before the program is run.
*/ */
PseudoInstruction(SignalProgram *prog, SignalOpcode op); PseudoInstruction(SignalProgram *prog, SignalOpcode op);
/** Removes the pseudo instruction. Unless you are also removing the If it /** Removes the pseudo instruction. Unless you are also removing the If it
* belongs to, this is nonsense and dangerous. * belongs to, this is nonsense and dangerous.
*/ */
virtual void Remove(); virtual void Remove();
/** Evaluate the pseudo instruction. This involves vectoring execution to /** Evaluate the pseudo instruction. This involves vectoring execution to
* the instruction after the if. * the instruction after the if.
*/ */
virtual void Evaluate(SignalVM &vm); virtual void Evaluate(SignalVM &vm);
/** The block to which this instruction belongs */ /** The block to which this instruction belongs */
SignalIf *block; SignalIf *block;
virtual void SetNext(SignalInstruction *next_insn); virtual void SetNext(SignalInstruction *next_insn);
}; };
public: public:
/** Constructs an If instruction belonging to program @p prog. If @p raw is /** Constructs an If instruction belonging to program @p prog. If @p raw is
* true, then the instruction is constructed raw (in order for the * true, then the instruction is constructed raw (in order for the
* deserializer to be able to correctly deserialize the instruction). * deserializer to be able to correctly deserialize the instruction).
*/ */
SignalIf(SignalProgram *prog, bool raw = false); SignalIf(SignalProgram *prog, bool raw = false);
/** Sets the instruction's condition, and releases the old condition */ /** Sets the instruction's condition, and releases the old condition */
void SetCondition(SignalCondition *cond); void SetCondition(SignalCondition *cond);
/** Evaluates the If and takes the appropriate branch */ /** Evaluates the If and takes the appropriate branch */
virtual void Evaluate(SignalVM &vm); virtual void Evaluate(SignalVM &vm);
virtual void Insert(SignalInstruction *before_insn); virtual void Insert(SignalInstruction *before_insn);
/** Removes the If and all of its children */ /** Removes the If and all of its children */
virtual void Remove(); virtual void Remove();
SignalCondition *condition; ///< The if conditon SignalCondition *condition; ///< The if conditon
SignalInstruction *if_true; ///< The branch to take if true SignalInstruction *if_true; ///< The branch to take if true
SignalInstruction *if_false; ///< The branch to take if false SignalInstruction *if_false; ///< The branch to take if false
SignalInstruction *after; ///< The branch to take after the If SignalInstruction *after; ///< The branch to take after the If
virtual void SetNext(SignalInstruction *next_insn); virtual void SetNext(SignalInstruction *next_insn);
}; };
@@ -343,16 +343,16 @@ class SignalSet: public SignalInstruction {
public: public:
/// Constructs the instruction and sets the state the signal is to be set to /// Constructs the instruction and sets the state the signal is to be set to
SignalSet(SignalProgram *prog, SignalState = SIGNAL_STATE_RED); SignalSet(SignalProgram *prog, SignalState = SIGNAL_STATE_RED);
virtual void Evaluate(SignalVM &vm); virtual void Evaluate(SignalVM &vm);
virtual void Remove(); virtual void Remove();
/// The state to set the signal to /// The state to set the signal to
SignalState to_state; SignalState to_state;
/// The instruction following this one (for the editor) /// The instruction following this one (for the editor)
SignalInstruction *next; SignalInstruction *next;
virtual void SetNext(SignalInstruction *next_insn); virtual void SetNext(SignalInstruction *next_insn);
}; };
@@ -369,7 +369,7 @@ static inline bool HasProgrammableSignals(SignalReference ref)
&& IsPresignalProgrammable(ref.tile, ref.track); && IsPresignalProgrammable(ref.tile, ref.track);
} }
/// Shows the programming window for the signal identified by @p tile and /// Shows the programming window for the signal identified by @p tile and
/// @p track. /// @p track.
void ShowSignalProgramWindow(SignalReference ref); void ShowSignalProgramWindow(SignalReference ref);

View File

@@ -770,10 +770,12 @@ void CheckRemoveSignalsFromTile(TileIndex tile)
static void NotifyRemovingDependentSignal(SignalReference on, SignalReference by) static void NotifyRemovingDependentSignal(SignalReference on, SignalReference by)
{ {
SignalType t = GetSignalType(by.tile, by.track); SignalType t = GetSignalType(by.tile, by.track);
if (IsProgrammableSignal(t)) { if (IsProgrammableSignal(t)) {
RemoveProgramDependencies(by, on); RemoveProgramDependencies(by, on);
} else DEBUG(misc, 0, "Removing dependency held by non-programmable signal (Unexpected)"); } else {
DEBUG(misc, 0, "Removing dependency held by non-programmable signal (Unexpected)");
}
} }
void CheckRemoveSignal(TileIndex tile, Track track) void CheckRemoveSignal(TileIndex tile, Track track)