mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r22396) -Document: some AI doxygen stuff

release/1.2
rubidium 2011-05-01 09:24:19 +00:00
parent abc2352537
commit 70c7ec30b1
18 changed files with 199 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
src/ai/ai_gui.cpp
View File

@ -45,12 +45,17 @@ enum AIListWindowWidgets {
* Window that let you choose an available AI. * Window that let you choose an available AI.
*/ */
struct AIListWindow : public Window { struct AIListWindow : public Window {
const AIInfoList *ai_info_list; const AIInfoList *ai_info_list; ///< The list of AIs.
int selected; int selected; ///< The currently selected AI.
CompanyID slot; CompanyID slot; ///< The company we're selecting a new AI for.
int line_height; // Height of a row in the matrix widget. int line_height; ///< Height of a row in the matrix widget.
Scrollbar *vscroll; Scrollbar *vscroll; ///< Cache of the vertical scrollbar.
/**
* Constructor for the window.
* @param desc The description of the window.
* @param slot The company we're changing the AI for.
*/
AIListWindow(const WindowDesc *desc, CompanyID slot) : Window(), AIListWindow(const WindowDesc *desc, CompanyID slot) : Window(),
slot(slot) slot(slot)
{ {
@ -135,6 +140,9 @@ struct AIListWindow : public Window {
} }
} }
/**
* Changes the AI of the current slot.
*/
void ChangeAI() void ChangeAI()
{ {
if (this->selected == -1) { if (this->selected == -1) {
@ -254,15 +262,20 @@ enum AISettingsWindowWidgest {
* Window for settings the parameters of an AI. * Window for settings the parameters of an AI.
*/ */
struct AISettingsWindow : public Window { struct AISettingsWindow : public Window {
CompanyID slot; CompanyID slot; ///< The currently show company's setting.
AIConfig *ai_config; AIConfig *ai_config; ///< The configuration we're modifying.
int clicked_button; int clicked_button; ///< The button we clicked.
bool clicked_increase; bool clicked_increase; ///< Whether we clicked the increase or decrease button.
int timeout; int timeout; ///< Timeout for unclicking the button.
int clicked_row; int clicked_row; ///< The clicked row of settings.
int line_height; // Height of a row in the matrix widget. int line_height; ///< Height of a row in the matrix widget.
Scrollbar *vscroll; Scrollbar *vscroll; ///< Cache of the vertical scrollbar.
/**
* Constructor for the window.
* @param desc The description of the window.
* @param slot The company we're changing the settings for.
*/
AISettingsWindow(const WindowDesc *desc, CompanyID slot) : Window(), AISettingsWindow(const WindowDesc *desc, CompanyID slot) : Window(),
slot(slot), slot(slot),
clicked_button(-1), clicked_button(-1),
@ -341,6 +354,9 @@ struct AISettingsWindow : public Window {
} }
} }
/**
* Check whether we modified the difficulty level or not.
*/
void CheckDifficultyLevel() void CheckDifficultyLevel()
{ {
if (_game_mode == GM_MENU) { if (_game_mode == GM_MENU) {
@ -556,7 +572,7 @@ static const WindowDesc _ai_config_desc(
struct AIConfigWindow : public Window { struct AIConfigWindow : public Window {
CompanyID selected_slot; ///< The currently selected AI slot or \c INVALID_COMPANY. CompanyID selected_slot; ///< The currently selected AI slot or \c INVALID_COMPANY.
int line_height; ///< Height of a single AI-name line. int line_height; ///< Height of a single AI-name line.
Scrollbar *vscroll; Scrollbar *vscroll; ///< Cache of the vertical scrollbar.
AIConfigWindow() : Window() AIConfigWindow() : Window()
{ {
@ -754,22 +770,27 @@ enum AIDebugWindowWidgets {
* Window with everything an AI prints via AILog. * Window with everything an AI prints via AILog.
*/ */
struct AIDebugWindow : public QueryStringBaseWindow { struct AIDebugWindow : public QueryStringBaseWindow {
static const int top_offset; ///< Offset of the text at the top of the ::AID_WIDGET_LOG_PANEL. static const int top_offset; ///< Offset of the text at the top of the AID_WIDGET_LOG_PANEL.
static const int bottom_offset; ///< Offset of the text at the bottom of the ::AID_WIDGET_LOG_PANEL. static const int bottom_offset; ///< Offset of the text at the bottom of the AID_WIDGET_LOG_PANEL.
static const unsigned int MAX_BREAK_STR_STRING_LENGTH = 256; static const unsigned int MAX_BREAK_STR_STRING_LENGTH = 256; ///< Maximum length of the break string.
static CompanyID ai_debug_company; ///< The AI that is (was last) being debugged. static CompanyID ai_debug_company; ///< The AI that is (was last) being debugged.
int redraw_timer; int redraw_timer; ///< Timer for redrawing the window, otherwise it'll happen every tick.
int last_vscroll_pos; int last_vscroll_pos; ///< Last position of the scrolling.
bool autoscroll; bool autoscroll; ///< Whether automatically scrolling should be enabled or not.
bool show_break_box; bool show_break_box; ///< Whether the break/debug box is visible.
static bool break_check_enabled; ///< Stop an AI when it prints a matching string static bool break_check_enabled; ///< Stop an AI when it prints a matching string
static char break_string[MAX_BREAK_STR_STRING_LENGTH]; ///< The string to match to the AI output static char break_string[MAX_BREAK_STR_STRING_LENGTH]; ///< The string to match to the AI output
static bool case_sensitive_break_check; ///< Is the matching done case-sensitive static bool case_sensitive_break_check; ///< Is the matching done case-sensitive
int highlight_row; ///< The output row that matches the given string, or -1 int highlight_row; ///< The output row that matches the given string, or -1
Scrollbar *vscroll; Scrollbar *vscroll; ///< Cache of the vertical scrollbar.
/**
* Constructor for the window.
* @param desc The description of the window.
* @param number The window number (actually unused).
*/
AIDebugWindow(const WindowDesc *desc, WindowNumber number) : QueryStringBaseWindow(MAX_BREAK_STR_STRING_LENGTH) AIDebugWindow(const WindowDesc *desc, WindowNumber number) : QueryStringBaseWindow(MAX_BREAK_STR_STRING_LENGTH)
{ {
this->CreateNestedTree(desc); this->CreateNestedTree(desc);
@ -969,6 +990,10 @@ struct AIDebugWindow : public QueryStringBaseWindow {
} }
} }
/**
* Change all settings to select another AI.
* @param show_ai The new AI to show.
*/
void ChangeToAI(CompanyID show_ai) void ChangeToAI(CompanyID show_ai)
{ {
this->RaiseWidget(ai_debug_company + AID_WIDGET_COMPANY_BUTTON_START); this->RaiseWidget(ai_debug_company + AID_WIDGET_COMPANY_BUTTON_START);

4
src/ai/ai_info.hpp
View File

@ -63,6 +63,10 @@ protected:
/** All static information from an AI like name, version, etc. */ /** All static information from an AI like name, version, etc. */
class AIInfo : public AIFileInfo { class AIInfo : public AIFileInfo {
public: public:
/**
* Get the class name, so the script code can create the right code.
* @return The class name.
*/
static const char *GetClassName() { return "AIInfo"; } static const char *GetClassName() { return "AIInfo"; }
AIInfo(); AIInfo();

20
src/ai/ai_instance.hpp
View File

@ -24,6 +24,11 @@ typedef void (AISuspendCallbackProc)(class AIInstance *instance);
*/ */
class AI_VMSuspend { class AI_VMSuspend {
public: public:
/**
* Create the suspend exception.
* @param time The amount of ticks to suspend.
* @param callback The callback to call when the AI may resume again.
*/
AI_VMSuspend(int time, AISuspendCallbackProc *callback) : AI_VMSuspend(int time, AISuspendCallbackProc *callback) :
time(time), time(time),
callback(callback) callback(callback)
@ -51,20 +56,33 @@ private:
*/ */
class AI_FatalError { class AI_FatalError {
public: public:
/**
* Creates a "fatal error" exception.
* @param msg The message describing the cause of the fatal error.
*/
AI_FatalError(const char *msg) : AI_FatalError(const char *msg) :
msg(msg) msg(msg)
{} {}
/**
* The error message associated with the fatal error.
* @return The error message.
*/
const char *GetErrorMessage() { return msg; } const char *GetErrorMessage() { return msg; }
private: private:
const char *msg; const char *msg; ///< The error message.
}; };
/** Runtime information about an AI like a pointer to the squirrel vm and the current state. */ /** Runtime information about an AI like a pointer to the squirrel vm and the current state. */
class AIInstance { class AIInstance {
public: public:
friend class AIObject; friend class AIObject;
/**
* Create a new AI.
* @param info The AI to create the instance of.
*/
AIInstance(class AIInfo *info); AIInstance(class AIInfo *info);
~AIInstance(); ~AIInstance();

14
src/ai/ai_scanner.hpp
View File

@ -38,6 +38,10 @@ public:
*/ */
void RegisterAI(class AIInfo *info); void RegisterAI(class AIInfo *info);
/**
* Register the dummy AI.
* @param info The dummy AI that.
*/
void SetDummyAI(class AIInfo *info) { this->info_dummy = info; } void SetDummyAI(class AIInfo *info) { this->info_dummy = info; }
/** /**
@ -79,7 +83,7 @@ public:
bool HasAI(const struct ContentInfo *ci, bool md5sum); bool HasAI(const struct ContentInfo *ci, bool md5sum);
#endif #endif
private: private:
typedef std::map<const char *, class AILibrary *, StringCompare> AILibraryList; typedef std::map<const char *, class AILibrary *, StringCompare> AILibraryList; ///< Type for the list of libraries.
/** /**
* Scan the AI dir for scripts. * Scan the AI dir for scripts.
@ -91,10 +95,10 @@ private:
*/ */
void Reset(); void Reset();
AIInfo *info_dummy; AIInfo *info_dummy; ///< The dummy AI.
AIInfoList info_list; AIInfoList info_list; ///< The list of all AIs.
AIInfoList info_single_list; AIInfoList info_single_list; ///< The list of all unique AIs, based on shortname. The best AI (highest version) is shown.
AILibraryList library_list; AILibraryList library_list; ///< The list of libraries.
}; };
#endif /* AI_SCANNER_HPP */ #endif /* AI_SCANNER_HPP */

2
src/ai/api/ai_accounting.hpp
View File

@ -62,7 +62,7 @@ public:
void ResetCosts(); void ResetCosts();
private: private:
Money last_costs; Money last_costs; ///< The last cost we did return.
}; };
#endif /* AI_ACCOUNTING_HPP */ #endif /* AI_ACCOUNTING_HPP */

12
src/ai/api/ai_bridge.cpp
View File

@ -35,6 +35,10 @@
return (BridgeID)::GetBridgeType(tile); return (BridgeID)::GetBridgeType(tile);
} }
/**
* Helper function to connect a just built bridge to nearby roads.
* @param instance The AI we have to built the road for.
*/
static void _DoCommandReturnBuildBridge2(class AIInstance *instance) static void _DoCommandReturnBuildBridge2(class AIInstance *instance)
{ {
if (!AIBridge::_BuildBridgeRoad2()) { if (!AIBridge::_BuildBridgeRoad2()) {
@ -47,6 +51,10 @@ static void _DoCommandReturnBuildBridge2(class AIInstance *instance)
NOT_REACHED(); NOT_REACHED();
} }
/**
* Helper function to connect a just built bridge to nearby roads.
* @param instance The AI we have to built the road for.
*/
static void _DoCommandReturnBuildBridge1(class AIInstance *instance) static void _DoCommandReturnBuildBridge1(class AIInstance *instance)
{ {
if (!AIBridge::_BuildBridgeRoad1()) { if (!AIBridge::_BuildBridgeRoad1()) {
@ -90,7 +98,7 @@ static void _DoCommandReturnBuildBridge1(class AIInstance *instance)
AIObject::SetCallbackVariable(0, start); AIObject::SetCallbackVariable(0, start);
AIObject::SetCallbackVariable(1, end); AIObject::SetCallbackVariable(1, end);
return AIObject::DoCommand(end, start, type | bridge_id, CMD_BUILD_BRIDGE, NULL, &_DoCommandReturnBuildBridge1); return AIObject::DoCommand(end, start, type | bridge_id, CMD_BUILD_BRIDGE, NULL, &::_DoCommandReturnBuildBridge1);
} }
/* static */ bool AIBridge::_BuildBridgeRoad1() /* static */ bool AIBridge::_BuildBridgeRoad1()
@ -102,7 +110,7 @@ static void _DoCommandReturnBuildBridge1(class AIInstance *instance)
DiagDirection dir_1 = ::DiagdirBetweenTiles(end, start); DiagDirection dir_1 = ::DiagdirBetweenTiles(end, start);
DiagDirection dir_2 = ::ReverseDiagDir(dir_1); DiagDirection dir_2 = ::ReverseDiagDir(dir_1);
return AIObject::DoCommand(start + ::TileOffsByDiagDir(dir_1), ::DiagDirToRoadBits(dir_2) | (AIObject::GetRoadType() << 4), 0, CMD_BUILD_ROAD, NULL, &_DoCommandReturnBuildBridge2); return AIObject::DoCommand(start + ::TileOffsByDiagDir(dir_1), ::DiagDirToRoadBits(dir_2) | (AIObject::GetRoadType() << 4), 0, CMD_BUILD_ROAD, NULL, &::_DoCommandReturnBuildBridge2);
} }
/* static */ bool AIBridge::_BuildBridgeRoad2() /* static */ bool AIBridge::_BuildBridgeRoad2()

2
src/ai/api/ai_changelog.hpp
View File

@ -141,7 +141,7 @@
* default for aircraft. It is not necessarily true. This means that even * default for aircraft. It is not necessarily true. This means that even
* if the aircraft can carry mail (as secondary cargo) it does not return * if the aircraft can carry mail (as secondary cargo) it does not return
* true if the aircraft cannot carry it as its only cargo. * true if the aircraft cannot carry it as its only cargo.
* \li Improve behaviour of (AIEngine|AIEventEnginePreview)::GetCargoType() * \li Improve behaviour of AIEngine::GetCargoType(), AIEventEnginePreview::GetCargoType()
* and AIEngine::CanRefitCargo() for articulated vehicles. For * and AIEngine::CanRefitCargo() for articulated vehicles. For
* CanRefitCargo true is returned if at least one part can be refitted. * CanRefitCargo true is returned if at least one part can be refitted.
* For GetCargoType the first most used cargo type is returned. * For GetCargoType the first most used cargo type is returned.

8
src/ai/api/ai_controller.hpp
View File

@ -103,11 +103,11 @@ public:
static void Print(bool error_msg, const char *message); static void Print(bool error_msg, const char *message);
private: private:
typedef std::map<const char *, const char *, StringCompare> LoadedLibraryList; typedef std::map<const char *, const char *, StringCompare> LoadedLibraryList; ///< The type for loaded libraries.
uint ticks; uint ticks; ///< The amount of ticks we're sleeping.
LoadedLibraryList loaded_library; LoadedLibraryList loaded_library; ///< The libraries we loaded.
int loaded_library_count; int loaded_library_count; ///< The amount of libraries.
/** /**
* Register all classes that are known inside the NoAI API. * Register all classes that are known inside the NoAI API.

8
src/ai/api/ai_error.hpp
View File

@ -172,11 +172,11 @@ public:
#endif /* EXPORT_SKIP */ #endif /* EXPORT_SKIP */
private: private:
typedef std::map<StringID, AIErrorType> AIErrorMap; typedef std::map<StringID, AIErrorType> AIErrorMap; ///< The type for mapping between error (internal OpenTTD) StringID to the AI error type.
typedef std::map<AIErrorType, const char *> AIErrorMapString; typedef std::map<AIErrorType, const char *> AIErrorMapString; ///< The type for mapping between error type and textual representation.
static AIErrorMap error_map; static AIErrorMap error_map; ///< The mapping between error (internal OpenTTD) StringID to the AI error type.
static AIErrorMapString error_map_string; static AIErrorMapString error_map_string; ///< The mapping between error type and textual representation.
}; };
#endif /* AI_ERROR_HPP */ #endif /* AI_ERROR_HPP */

3
src/ai/api/ai_event.cpp
View File

@ -14,8 +14,9 @@
#include <queue> #include <queue>
/** The queue of events for an AI. */
struct AIEventData { struct AIEventData {
std::queue<AIEvent *> stack; std::queue<AIEvent *> stack; ///< The actual queue.
}; };
/* static */ void AIEventController::CreateEventPointer() /* static */ void AIEventController::CreateEventPointer()

59
src/ai/api/ai_event_types.hpp
View File

@ -74,9 +74,9 @@ public:
CrashReason GetCrashReason() { return this->crash_reason; } CrashReason GetCrashReason() { return this->crash_reason; }
private: private:
TileIndex crash_site; TileIndex crash_site; ///< The location of the crash.
VehicleID vehicle; VehicleID vehicle; ///< The crashed vehicle.
CrashReason crash_reason; CrashReason crash_reason; ///< The reason for crashing.
}; };
/** /**
@ -109,7 +109,7 @@ public:
SubsidyID GetSubsidyID() { return this->subsidy_id; } SubsidyID GetSubsidyID() { return this->subsidy_id; }
private: private:
SubsidyID subsidy_id; SubsidyID subsidy_id; ///< The subsidy that got offered.
}; };
/** /**
@ -142,7 +142,7 @@ public:
SubsidyID GetSubsidyID() { return this->subsidy_id; } SubsidyID GetSubsidyID() { return this->subsidy_id; }
private: private:
SubsidyID subsidy_id; SubsidyID subsidy_id; ///< The subsidy offer that expired.
}; };
/** /**
@ -175,7 +175,7 @@ public:
SubsidyID GetSubsidyID() { return this->subsidy_id; } SubsidyID GetSubsidyID() { return this->subsidy_id; }
private: private:
SubsidyID subsidy_id; SubsidyID subsidy_id; ///< The subsidy that was awared.
}; };
/** /**
@ -208,7 +208,7 @@ public:
SubsidyID GetSubsidyID() { return this->subsidy_id; } SubsidyID GetSubsidyID() { return this->subsidy_id; }
private: private:
SubsidyID subsidy_id; SubsidyID subsidy_id; ///< The subsidy that expired.
}; };
/** /**
@ -278,11 +278,11 @@ public:
*/ */
Money GetRunningCost(); Money GetRunningCost();
#ifdef DOXYGEN_SKIP
/** /**
* Get the type of the offered engine. * Get the type of the offered engine.
* @return The type the engine has. * @return The type the engine has.
*/ */
#ifdef DOXYGEN_SKIP
AIVehicle::VehicleType GetVehicleType(); AIVehicle::VehicleType GetVehicleType();
#else #else
int32 GetVehicleType(); int32 GetVehicleType();
@ -295,7 +295,12 @@ public:
bool AcceptPreview(); bool AcceptPreview();
private: private:
EngineID engine; EngineID engine; ///< The engine the preview is for.
/**
* Check whether the engine from this preview is still valid.
* @return True iff the engine is still valid.
*/
bool IsEngineValid() const; bool IsEngineValid() const;
}; };
@ -329,7 +334,7 @@ public:
AICompany::CompanyID GetCompanyID() { return this->owner; } AICompany::CompanyID GetCompanyID() { return this->owner; }
private: private:
AICompany::CompanyID owner; AICompany::CompanyID owner; ///< The new company.
}; };
/** /**
@ -363,7 +368,7 @@ public:
AICompany::CompanyID GetCompanyID() { return this->owner; } AICompany::CompanyID GetCompanyID() { return this->owner; }
private: private:
AICompany::CompanyID owner; AICompany::CompanyID owner; ///< The company that is in trouble.
}; };
/** /**
@ -411,8 +416,8 @@ public:
bool AcceptMerger(); bool AcceptMerger();
private: private:
AICompany::CompanyID owner; AICompany::CompanyID owner; ///< The company that is in trouble.
int32 value; int32 value; ///< The value of the company, i.e. the amount you would pay.
}; };
/** /**
@ -457,8 +462,8 @@ public:
AICompany::CompanyID GetNewCompanyID() { return this->new_owner; } AICompany::CompanyID GetNewCompanyID() { return this->new_owner; }
private: private:
AICompany::CompanyID old_owner; AICompany::CompanyID old_owner; ///< The company that ended to exist.
AICompany::CompanyID new_owner; AICompany::CompanyID new_owner; ///< The company that's the end result of the merger.
}; };
/** /**
@ -491,7 +496,7 @@ public:
AICompany::CompanyID GetCompanyID() { return this->owner; } AICompany::CompanyID GetCompanyID() { return this->owner; }
private: private:
AICompany::CompanyID owner; AICompany::CompanyID owner; ///< The company that has gone bankrupt.
}; };
/** /**
@ -524,7 +529,7 @@ public:
VehicleID GetVehicleID() { return this->vehicle_id; } VehicleID GetVehicleID() { return this->vehicle_id; }
private: private:
VehicleID vehicle_id; VehicleID vehicle_id; ///< The vehicle that is lost.
}; };
/** /**
@ -557,7 +562,7 @@ public:
VehicleID GetVehicleID() { return this->vehicle_id; } VehicleID GetVehicleID() { return this->vehicle_id; }
private: private:
VehicleID vehicle_id; VehicleID vehicle_id; ///< The vehicle that is waiting in the depot.
}; };
/** /**
@ -590,7 +595,7 @@ public:
VehicleID GetVehicleID() { return this->vehicle_id; } VehicleID GetVehicleID() { return this->vehicle_id; }
private: private:
VehicleID vehicle_id; VehicleID vehicle_id; ///< The vehicle that is unprofitable.
}; };
/** /**
@ -623,7 +628,7 @@ public:
IndustryID GetIndustryID() { return this->industry_id; } IndustryID GetIndustryID() { return this->industry_id; }
private: private:
IndustryID industry_id; IndustryID industry_id; ///< The industry that opened.
}; };
/** /**
@ -656,7 +661,7 @@ public:
IndustryID GetIndustryID() { return this->industry_id; } IndustryID GetIndustryID() { return this->industry_id; }
private: private:
IndustryID industry_id; IndustryID industry_id; ///< The industry that closed.
}; };
/** /**
@ -689,7 +694,7 @@ public:
EngineID GetEngineID() { return this->engine; } EngineID GetEngineID() { return this->engine; }
private: private:
EngineID engine; EngineID engine; ///< The engine that became available.
}; };
/** /**
@ -730,8 +735,8 @@ public:
VehicleID GetVehicleID() { return this->vehicle; } VehicleID GetVehicleID() { return this->vehicle; }
private: private:
StationID station; StationID station; ///< The station the vehicle arived at.
VehicleID vehicle; VehicleID vehicle; ///< The vehicle that arrived at the station.
}; };
/** /**
@ -764,7 +769,7 @@ public:
StationID GetStationID() { return this->station; } StationID GetStationID() { return this->station; }
private: private:
StationID station; StationID station; ///< The station the zeppeliner crashed.
}; };
/** /**
@ -797,7 +802,7 @@ public:
StationID GetStationID() { return this->station; } StationID GetStationID() { return this->station; }
private: private:
StationID station; StationID station; ///< The station the zeppeliner crashed.
}; };
/** /**
@ -830,7 +835,7 @@ public:
TownID GetTownID() { return this->town; } TownID GetTownID() { return this->town; }
private: private:
TownID town; TownID town; ///< The town that got founded.
}; };
#endif /* AI_EVENT_TYPES_HPP */ #endif /* AI_EVENT_TYPES_HPP */

4
src/ai/api/ai_execmode.hpp
View File

@ -27,8 +27,8 @@ public:
static const char *GetClassName() { return "AIExecMode"; } static const char *GetClassName() { return "AIExecMode"; }
private: private:
AIModeProc *last_mode; AIModeProc *last_mode; ///< The previous mode we were in.
AIObject *last_instance; AIObject *last_instance; ///< The previous instace of the mode.
protected: protected:
/** /**

81
src/ai/api/ai_list.cpp
View File

@ -19,7 +19,9 @@
*/ */
class AIListSorter { class AIListSorter {
protected: protected:
AIList *list; AIList *list; ///< The list that's being sorted.
bool has_no_more_items; ///< Whether we have more items to iterate over.
int32 item_next; ///< The next item we will show.
public: public:
/** /**
@ -45,7 +47,10 @@ public:
/** /**
* See if the sorter has reached the end. * See if the sorter has reached the end.
*/ */
virtual bool IsEnd() = 0; bool IsEnd()
{
return this->list->buckets.empty() || this->has_no_more_items;
}
/** /**
* Callback from the list if an item gets removed. * Callback from the list if an item gets removed.
@ -58,13 +63,15 @@ public:
*/ */
class AIListSorterValueAscending : public AIListSorter { class AIListSorterValueAscending : public AIListSorter {
private: private:
AIList::AIListBucket::iterator bucket_iter; AIList::AIListBucket::iterator bucket_iter; ///< The iterator over the list to find the buckets.
AIList::AIItemList *bucket_list; AIList::AIItemList *bucket_list; ///< The current bucket list we're iterator over.
AIList::AIItemList::iterator bucket_list_iter; AIList::AIItemList::iterator bucket_list_iter; ///< The iterator over the bucket list.
bool has_no_more_items;
int32 item_next;
public: public:
/**
* Create a new sorter.
* @param list The list to sort.
*/
AIListSorterValueAscending(AIList *list) AIListSorterValueAscending(AIList *list)
{ {
this->list = list; this->list = list;
@ -93,6 +100,9 @@ public:
this->item_next = 0; this->item_next = 0;
} }
/**
* Find the next item, and store that information.
*/
void FindNext() void FindNext()
{ {
if (this->bucket_list == NULL) { if (this->bucket_list == NULL) {
@ -132,11 +142,6 @@ public:
return; return;
} }
} }
bool IsEnd()
{
return this->list->buckets.empty() || this->has_no_more_items;
}
}; };
/** /**
@ -144,13 +149,15 @@ public:
*/ */
class AIListSorterValueDescending : public AIListSorter { class AIListSorterValueDescending : public AIListSorter {
private: private:
AIList::AIListBucket::iterator bucket_iter; AIList::AIListBucket::iterator bucket_iter; ///< The iterator over the list to find the buckets.
AIList::AIItemList *bucket_list; AIList::AIItemList *bucket_list; ///< The current bucket list we're iterator over.
AIList::AIItemList::iterator bucket_list_iter; AIList::AIItemList::iterator bucket_list_iter; ///< The iterator over the bucket list.
bool has_no_more_items;
int32 item_next;
public: public:
/**
* Create a new sorter.
* @param list The list to sort.
*/
AIListSorterValueDescending(AIList *list) AIListSorterValueDescending(AIList *list)
{ {
this->list = list; this->list = list;
@ -184,6 +191,9 @@ public:
this->item_next = 0; this->item_next = 0;
} }
/**
* Find the next item, and store that information.
*/
void FindNext() void FindNext()
{ {
if (this->bucket_list == NULL) { if (this->bucket_list == NULL) {
@ -226,11 +236,6 @@ public:
return; return;
} }
} }
bool IsEnd()
{
return this->list->buckets.empty() || this->has_no_more_items;
}
}; };
/** /**
@ -238,11 +243,13 @@ public:
*/ */
class AIListSorterItemAscending : public AIListSorter { class AIListSorterItemAscending : public AIListSorter {
private: private:
AIList::AIListMap::iterator item_iter; AIList::AIListMap::iterator item_iter; ///< The iterator over the items in the map.
bool has_no_more_items;
int32 item_next;
public: public:
/**
* Create a new sorter.
* @param list The list to sort.
*/
AIListSorterItemAscending(AIList *list) AIListSorterItemAscending(AIList *list)
{ {
this->list = list; this->list = list;
@ -267,6 +274,9 @@ public:
this->has_no_more_items = true; this->has_no_more_items = true;
} }
/**
* Find the next item, and store that information.
*/
void FindNext() void FindNext()
{ {
if (this->item_iter == this->list->items.end()) { if (this->item_iter == this->list->items.end()) {
@ -296,11 +306,6 @@ public:
return; return;
} }
} }
bool IsEnd()
{
return this->list->items.empty() || this->has_no_more_items;
}
}; };
/** /**
@ -308,11 +313,13 @@ public:
*/ */
class AIListSorterItemDescending : public AIListSorter { class AIListSorterItemDescending : public AIListSorter {
private: private:
AIList::AIListMap::iterator item_iter; AIList::AIListMap::iterator item_iter; ///< The iterator over the items in the map.
bool has_no_more_items;
int32 item_next;
public: public:
/**
* Create a new sorter.
* @param list The list to sort.
*/
AIListSorterItemDescending(AIList *list) AIListSorterItemDescending(AIList *list)
{ {
this->list = list; this->list = list;
@ -338,6 +345,9 @@ public:
this->has_no_more_items = true; this->has_no_more_items = true;
} }
/**
* Find the next item, and store that information.
*/
void FindNext() void FindNext()
{ {
if (this->item_iter == this->list->items.end()) { if (this->item_iter == this->list->items.end()) {
@ -367,11 +377,6 @@ public:
return; return;
} }
} }
bool IsEnd()
{
return this->list->items.empty() || this->has_no_more_items;
}
}; };

4
src/ai/api/ai_object.cpp
View File

@ -21,6 +21,10 @@
#include "../ai_instance.hpp" #include "../ai_instance.hpp"
#include "ai_error.hpp" #include "ai_error.hpp"
/**
* Get the storage associated with the current AIInstance.
* @return The storage.
*/
static AIStorage *GetStorage() static AIStorage *GetStorage()
{ {
return AIInstance::GetStorage(); return AIInstance::GetStorage();

1
src/ai/api/ai_object.hpp
View File

@ -148,6 +148,7 @@ protected:
* from CanSuspend() if the reason we are not allowed * from CanSuspend() if the reason we are not allowed
* to execute a DoCommand is in squirrel and not the API. * to execute a DoCommand is in squirrel and not the API.
* In that case use this function to restore the previous value. * In that case use this function to restore the previous value.
* @return True iff DoCommands are allowed in the current scope.
*/ */
static bool GetAllowDoCommand(); static bool GetAllowDoCommand();

8
src/ai/api/ai_order.cpp
View File

@ -512,7 +512,7 @@ static void _DoCommandReturnSetOrderFlags(class AIInstance *instance)
EnforcePrecondition(false, (order_flags & AIOF_GOTO_NEAREST_DEPOT) == (current & AIOF_GOTO_NEAREST_DEPOT)); EnforcePrecondition(false, (order_flags & AIOF_GOTO_NEAREST_DEPOT) == (current & AIOF_GOTO_NEAREST_DEPOT));
if ((current & AIOF_NON_STOP_FLAGS) != (order_flags & AIOF_NON_STOP_FLAGS)) { if ((current & AIOF_NON_STOP_FLAGS) != (order_flags & AIOF_NON_STOP_FLAGS)) {
return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (order_flags & AIOF_NON_STOP_FLAGS) << 4 | MOF_NON_STOP, CMD_MODIFY_ORDER, NULL, &_DoCommandReturnSetOrderFlags); return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (order_flags & AIOF_NON_STOP_FLAGS) << 4 | MOF_NON_STOP, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
} }
switch (order->GetType()) { switch (order->GetType()) {
@ -521,16 +521,16 @@ static void _DoCommandReturnSetOrderFlags(class AIInstance *instance)
uint data = DA_ALWAYS_GO; uint data = DA_ALWAYS_GO;
if (order_flags & AIOF_SERVICE_IF_NEEDED) data = DA_SERVICE; if (order_flags & AIOF_SERVICE_IF_NEEDED) data = DA_SERVICE;
if (order_flags & AIOF_STOP_IN_DEPOT) data = DA_STOP; if (order_flags & AIOF_STOP_IN_DEPOT) data = DA_STOP;
return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (data << 4) | MOF_DEPOT_ACTION, CMD_MODIFY_ORDER, NULL, &_DoCommandReturnSetOrderFlags); return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (data << 4) | MOF_DEPOT_ACTION, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
} }
break; break;
case OT_GOTO_STATION: case OT_GOTO_STATION:
if ((current & AIOF_UNLOAD_FLAGS) != (order_flags & AIOF_UNLOAD_FLAGS)) { if ((current & AIOF_UNLOAD_FLAGS) != (order_flags & AIOF_UNLOAD_FLAGS)) {
return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (order_flags & AIOF_UNLOAD_FLAGS) << 2 | MOF_UNLOAD, CMD_MODIFY_ORDER, NULL, &_DoCommandReturnSetOrderFlags); return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (order_flags & AIOF_UNLOAD_FLAGS) << 2 | MOF_UNLOAD, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
} }
if ((current & AIOF_LOAD_FLAGS) != (order_flags & AIOF_LOAD_FLAGS)) { if ((current & AIOF_LOAD_FLAGS) != (order_flags & AIOF_LOAD_FLAGS)) {
return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (order_flags & AIOF_LOAD_FLAGS) >> 1 | MOF_LOAD, CMD_MODIFY_ORDER, NULL, &_DoCommandReturnSetOrderFlags); return AIObject::DoCommand(0, vehicle_id | (order_position << 20), (order_flags & AIOF_LOAD_FLAGS) >> 1 | MOF_LOAD, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
} }
break; break;

4
src/ai/api/ai_testmode.hpp
View File

@ -29,8 +29,8 @@ public:
static const char *GetClassName() { return "AITestMode"; } static const char *GetClassName() { return "AITestMode"; }
private: private:
AIModeProc *last_mode; AIModeProc *last_mode; ///< The previous mode we were in.
AIObject *last_instance; AIObject *last_instance; ///< The previous instace of the mode.
protected: protected:
/** /**

12
src/ai/api/ai_tunnel.cpp
View File

@ -46,6 +46,10 @@
return tile; return tile;
} }
/**
* Helper function to connect a just built tunnel to nearby roads.
* @param instance The AI we have to built the road for.
*/
static void _DoCommandReturnBuildTunnel2(class AIInstance *instance) static void _DoCommandReturnBuildTunnel2(class AIInstance *instance)
{ {
if (!AITunnel::_BuildTunnelRoad2()) { if (!AITunnel::_BuildTunnelRoad2()) {
@ -58,6 +62,10 @@ static void _DoCommandReturnBuildTunnel2(class AIInstance *instance)
NOT_REACHED(); NOT_REACHED();
} }
/**
* Helper function to connect a just built tunnel to nearby roads.
* @param instance The AI we have to built the road for.
*/
static void _DoCommandReturnBuildTunnel1(class AIInstance *instance) static void _DoCommandReturnBuildTunnel1(class AIInstance *instance)
{ {
if (!AITunnel::_BuildTunnelRoad1()) { if (!AITunnel::_BuildTunnelRoad1()) {
@ -91,7 +99,7 @@ static void _DoCommandReturnBuildTunnel1(class AIInstance *instance)
} }
AIObject::SetCallbackVariable(0, start); AIObject::SetCallbackVariable(0, start);
return AIObject::DoCommand(start, type, 0, CMD_BUILD_TUNNEL, NULL, &_DoCommandReturnBuildTunnel1); return AIObject::DoCommand(start, type, 0, CMD_BUILD_TUNNEL, NULL, &::_DoCommandReturnBuildTunnel1);
} }
/* static */ bool AITunnel::_BuildTunnelRoad1() /* static */ bool AITunnel::_BuildTunnelRoad1()
@ -103,7 +111,7 @@ static void _DoCommandReturnBuildTunnel1(class AIInstance *instance)
DiagDirection dir_1 = ::DiagdirBetweenTiles(end, start); DiagDirection dir_1 = ::DiagdirBetweenTiles(end, start);
DiagDirection dir_2 = ::ReverseDiagDir(dir_1); DiagDirection dir_2 = ::ReverseDiagDir(dir_1);
return AIObject::DoCommand(start + ::TileOffsByDiagDir(dir_1), ::DiagDirToRoadBits(dir_2) | (AIObject::GetRoadType() << 4), 0, CMD_BUILD_ROAD, NULL, &_DoCommandReturnBuildTunnel2); return AIObject::DoCommand(start + ::TileOffsByDiagDir(dir_1), ::DiagDirToRoadBits(dir_2) | (AIObject::GetRoadType() << 4), 0, CMD_BUILD_ROAD, NULL, &::_DoCommandReturnBuildTunnel2);
} }
/* static */ bool AITunnel::_BuildTunnelRoad2() /* static */ bool AITunnel::_BuildTunnelRoad2()