diff --git a/.changelog b/.changelog index cda3d531..4cab8580 100644 --- a/.changelog +++ b/.changelog @@ -1,9 +1,282 @@ -13.4 (2023-07-29) +14.0-beta1 (2023-02-03) ------------------------------------------------------------------------ -Fix: Setting tree lines drawn incorrectly for RTL languages (#11070) -Fix #11043: Don't choose toolbar dropdown option if focus is lost (#11044) -Fix #10917: Pay loan interest before generating statistics (#11040) -Fix #11016: Use after free in network invalid packet error path (#11022) -Fix #10987: Double-close of dropdown stopped land-info tool working as default (#11000) +Feature: Order option to unbunch vehicles at depot (#11945) +Feature: Infinite money mode (#11902) +Feature: Setting to disable the loading speed penalty for trains longer than the station (#11682) +Feature: Plugin framework for Social Integration with Steam, Discord, GOG, etc (#11628) +Feature: Scalable OpenTTD TrueType font made by Zephyris (#11593) +Feature: Toyland-specific river graphics (#11523) +Feature: Add zoom level buttons to sprite aligner (#11518) +Feature: Add shading to river slopes (#11491) +Feature: Place cargo icon on cargo filter dropdowns (#11487) +Feature: Mode to display timetable in seconds (#11435) +Feature: Setting to influence how many minutes a calendar year takes (#11428) +Feature: Base graphics can offer parameters for additional settings (#11347) +Feature: Sandbox option to lock station ratings at 100% (#11346) +Feature: Setting to use real-time "wallclock" as timekeeping units (#11341) +Feature: Setting to automatically restart server based on hours played (#11142) +Feature: Add config option to set default company secondary colour for new games (#11068) +Feature: Transparency option for cost and income indicators (#11001) +Feature: Create group of vehicles from manage vehicle list button (#10890) +Feature: Show coverage highlight the same as stations when adding waypoints (#10875) +Feature: Show the number of industries already built in the Fund New Industry window (#10806) +Feature: Add search filter and name text to build waypoint window (#10786) +Feature: Setting to disallow level crossings with competitors (#10755) +Feature: Opt-in survey when leaving a game (#10719) +Feature: Replace buying/selling company shares with hostile takeovers of AI companies (#10709, #10914) +Feature: Settings to scale cargo production of towns and industries (#10606) +Feature: Separate rail/road and sea/air velocity units, and add knots (#10594) +Feature: Region-based pathfinder for ships (#10543) +Feature: Filter engine build menu by name and NewGRF extra text (#10519) +Feature: Industry directory text filter (#10518) +Feature: Ctrl+Click to reset late counter for the entire vehicle group (#10464) +Feature: Orientation of rail and road depots can be changed (#9642) +Feature: Display help and manuals in-game (#7786) +Feature: [NewGRF] Town production effect and multiplier (#11947) +Feature: [NewGRF] Randomize direction of rail vehicle on build based on probability callback (#11489) +Feature: [NewGRF] Related Act2 objects for airports and airport tiles (#11282) +Feature: [NewGRF] Allow higher max speeds for ships (#10734) +Feature: [NewGRF] Increase limit of objects/stations/roadstops per NewGRF (#10672) +Feature: [NewGRF] Road stops (#10144) +Feature: [Script] Goal destination can be updated (#10817) +Add: Argument for console command "restart" to use either current or newgame settings (#11962, #11963) +Add: {CURRENCY_SHORT} only did k / m suffix. Add bn / tn and make translatable (#11921) +Add: Show in multiplayer the amount of hours a game has been unpaused (#11886) +Add: Allow loading heightmaps from command-line (#11870) +Add: List_[scenario|heightmap] and load_[scenario|height] console commands (#11867) +Add: Latvian Lats currency (#11691) +Add: Horizontal scroll for script debug log (#11597) +Add: GUI options to select sprite font and AA mode for all fonts (#11593) +Add: Website button for basesets in Game Options window, the Game Script settings window and AI settings window (#11512) +Add: [Emscripten] Support for bootstrapping (#11109) +Add: Hotkey to focus town / industry directory filter box (#11030) +Add: Maximum number of companies allowed to the client list (#10523) +Add: Use specific error message when vehicle cannot go to station/waypoint (#10494) +Add: Show NewGRF name in NewGRF-created errors (#10457) +Add: Alternative setting for right-click close window option to exclude pinned windows (#10204) +Add: Allow autoreplace with same model vehicle (#7729) +Add: [NewGRF] Allow inspection of road tiles and airports (#11282, #11323) +Add: [NewGRF] Station variable 6B to get extended station id of nearby tiles (#10953) +Add: [NewGRF] String code "9A 21" to display force from textstack (#10782) +Add: [NewGRF] Station property 1C/1D to set name/classname (#10672) +Add: [Script] Optional filter parameter to ScriptXXXList constructors (#11698,#11663) +Add: [Script] AI/GS Time Mode to choose between economy (default) and calendar time (#11603) +Add: [Script] Allow to set max loan for each company separately (#11224) +Add: [Script] GSIndustry.GetConstructionDate() method (#11145) +Add: [Script] Game script control of industry production level and news messages (#11141) +Add: [Script] GSAsyncMode to set async mode of gamescript commands (#10913) +Add: [Script] GSCompanyMode::IsValid and IsDeity, and enforce valid company/deity mode where applicable (#10536, #10529) +Add: [Script] Allow GS to found town with random road layout (#10442) +Add: [Script] Create own Randomizer per instance (#10349) +Change: Better handle different GUI sizes for most windows, and squash inconsistencies between windows +Change: Allow configuring AI slots above the current maximum number of competitors (#11961) +Change: Forcefully enable prefixing logs with date (#11930) +Change: Position error window closer to cursor on large screens (#11923) +Change: Only open story-book in center when a GS does it (#11916) +Change: Rebrand Cheats as Sandbox Options (#11874) +Change: Make smooth-scrolling based on actual time (#11865) +Change: Set smooth-scrolling on by default (#11860) +Change: Disable building rail infrastructure if train build limit is zero (#11847) +Change: Invalidate music volume when restarting music playback on Windows (#11836) +Change: Make street lights transparent with houses (#11828) +Change: Redesign script debug window (#11782) +Change: Reorganize Settings menu items (#11683) +Change: Set amount of smoke/sparks to "realistic" by default (#11624) +Change: Show a message in livery window if vehicle type has no groups (#11617) +Change: Add distinct tooltips for vehicle group colour schemes (#11617) +Change: Move colour selection dropdowns to bottom of window (#11617) +Change: Support custom transparency remaps with 32bpp blitters (#11616) +Change: Make "middle" the default stopping location for trains in platforms (#11605) +Change: Scale sprites to requested highest resolution level (#11600) +Change: Allow opening multiple script debug windows by holding Ctrl (#11592) +Change: Don't show scoring year in high score table (#11546) +Change: Revert pressed-button content shifting introduced in r2161 (#11542) +Change: Show rating in station list even with no cargo waiting (#11540) +Change: Hide unused cargos from vehicle cargo filter (#11533) +Change: Don't restart playback when toggling playlist shuffle (#11504) +Change: Increase finance window lines (and underlines) with interface scale (#11459) +Change: Move baseset missing/corrupted files label to list item (#11455) +Change: Add horizontal scrollbar to Industry Directory window (#11434) +Change: Improve layout of airport, dock, object, road/tram stop, train station pickers (#11430) +Change: Display cargo lists in sorted cargo order (#11383) +Change: Link houses production on industry chain graph by TPE_PASSENGERS or TPE_MAIL cargo (#11378) +Change: Passenger subsidies are generated for any TPE_PASSENGER cargo type (#11378) +Change: Towns generate cargo based on town production effect (#11378) +Change: Always allow expanding towns in Scenario Editor to build new roads (#11377) +Change: Don't set vehicle on time if timetable not started (#11359) +Change: Store station blocked/wires/pylons flags in map (#11337) +Change: Recover when possible from crashes during a crash (#11238) +Change: Store crash logs in JSON format (#11232) +Change: Remove autosave from settings window; it is already in the Game Options (#11218) +Change: Enable "Forbid 90 degree turns" setting by default (#11160) +Change: Do not allow mixing road/tram types in powered road type list (#11148) +Change: Only show platform stopping location in orders when other than default (#11102) +Change: Autorail / autoroad tools can start dragging from invalid tiles (#11089) +Change: Only allow buying Exclusive Transport Rights when no one has them (#11076) +Change: Remove currency code/symbol suffix from language files (#11061) +Change: Add separate setting for server sent commands per frame limit (#11023) +Change: Cargo flow legend only shows defined cargo (#10872) +Change: Use "Via-Destination-Source" as default station cargodist display (#10851) +Change: Preserve orders and related settings where possible when moving engines around in a train (#10799) +Change: Standardise unit conversions and allow decimal places (#10795) +Change: Use separate names for default stations/roadstops (#10786) +Change: [MacOS] Require at least 10.15 to run the game (#10745) +Change: Hide all variants from UI when (display) parent is hidden (#10708) +Change: Split Game options into General, Graphics and Sound tabs (#10674) +Change: Extend entity override manager and station spec lists to support 16 bit IDs (#10672) +Change: Base autosaves intervals on real time (instead of game time) (#10655) +Change: Allow overbuilding station and waypoint tiles (#10618) +Change: Use realtime for Linkgraph update settings (#10610) +Change: Make tick length 27 milliseconds (#10607) +Change: Increase max cargo age and let min cargo payment approach zero (#10596) +Change: Show buy company dialog window even when playing in the AI company (#10459) +Change: Use HTTPS for content-service connections (#10448) +Change: Big UFO disaster targets current location of a random train (#10290) +Change: Remove land generator setting from World Generation GUI (#10093) +Change: Build signals to the next junction when dragging regardless of the Ctrl state (#9637) +Change: Allow dedicated server to use threaded saves (#10787) +Change: [NewGRF] Increase vehicle random data from 8 to 16 bits (#10701) +Change: [NewGRF] Read Action 3 IDs as extended-bytes for all features (#10672) +Change: [NewGRF] Make Action 3 debug messages more consistent (#10672) +Change: [NewGRF] Extend callback 161 (engine name) with bit 0x22 for context 'Autoreplace - Vehicles in use' (#10666) +Change: [Script] Replace easy/medium/hard values with default value (#11959) +Change: [Script] Limit total script ops that can be consumed by a list valuate (#11670) +Change: [Script] Allow GS access to ScriptGroup, ScriptGameSettings.IsDisabledVehicleType, more ScriptCompany and more ScriptOrder functions (#10642) +Change: [Script] Improve ScriptText validation error messages (#10545) +Change: [Script] Restore support of {RAW_STRING} in ScriptText (#10492) +Change: [Script] Validate ScriptText parameters type and amount (#10492) +Change: [Script] Automate the ScriptObject reference counting (#10492) +Change: [Script] Extract params info from GS strings (#10492) +Change: [Script] A ScriptText with too many parameters is now a fatal error (#10483) +Change: [Script] Log AI/GS Squirrel crashes in white text for readability (#10375) +Fix #11918: Houses should only build next to road stops, not any station type (#11919) +Fix #11827: Make text layouter aware of ligatures (#11831) +Fix #11752: Characters could be repeated when wrapping multi-line text (#11761) +Fix #11748: Decreasing service interval value sufficiently would result in it wrapping around (#11749) +Fix #11629: Crash when getting the nearest town for rotated airports (#11631) +Fix #11516: Adjust window size by interface scale during ReInit (#11517) +Fix #11515: Changing interface scale could have unintended effects on zoom level (#11615) +Fix #11442: "Default" colour in group colour window is not updated when changing master colour (#11614) +Fix #11437: Flipped shorter rail vehicles disappear in windows (#11446) +Fix #11413: Incorrect sorting by industry production (#11414) +Fix #11407: Don't steal focus from dropdown menus (#11484) +Fix #11402: Make string filter locale-aware (#11426) +Fix #11329: Don't assert vehicle list length is non-zero when only asked to set string parameter (#11330) +Fix #11315: Sort industries and cargoes by name in industry chain window (#11317) +Fix #11307: Incorrect GroupStatistics after selling leading wagon (#11311) +Fix #11261: Airport menu selectability after closing window on a class with no available airports (#11344) +Fix #11230: Sort by button in group list window could be misaligned (#11231) +Fix #11215: Assert in NewGRF parameters window (manual parameter mode) (#11217) +Fix #11203: [Linux] Crash when editing CJK characters in edit box (#11204) +Fix #11180: Aircraft crashes could point to the wrong tile (#11184) +Fix #11164: Don't create duplicate town names when using 'Many random towns' in the scenario editor (#11165) +Fix #11162: Second company colour was not consistently applied to articulated vehicles (#11163) +Fix #11115: Focus the abandon game/exit game windows (#11125) +Fix #11096: Increase priority of error and confirmation windows (#11104) +Fix #11087: Disable base graphics/sound dropdown outside main menu (#11091) +Fix #11054: Prevent translation of currency codes (#11061) +Fix #11026: Use real engine name instead of default name for filtering (#11033) +Fix #10982: No help text for gamelog command (#10984) +Fix #10880: Crash in object window due to incorrect parameter order (#10881) +Fix #10868: Crash when Script tries to load large savegame data (#11029) +Fix #10811: Allow dragging vehicle in depot to any free row (#11508) +Fix #10660: Sprite Font scale affected by viewport zoom level limits (#10668) +Fix #10619: Crash loading linkgraph for older savegames (#10620) +Fix #10600: 'Replace Vehicles' didn't show numbers >999 (#10680) +Fix #10578: Allow to select any version of AI/GS from GUI (#10604) +Fix #10522: Link graph tooltip vertical lines were not handled correctly (#10524) +Fix #10511: Don't search for depot every tick if one cannot be found (#11548) +Fix #10478: Clarify airport noise control setting texts (#11169) +Fix #10452: Prevent long stalls during river generation (#11544) +Fix #10430: Display chain window causing assert (#10431) +Fix #10343: Don't extend town-disallowed roadtypes (#10347) +Fix #10251: [MacOS] Screen looks blue-ish when using newer SDKs (#11207) +Fix #10222: Adjust line drawing algorithm (#10491) +Fix #10131: Actually cancel downloads when pressing cancel (#10485) +Fix #10118: Cycle through current signal group, not just path signals (#11798) +Fix #10439: [Script] Validate story page button colour, flags, cursor and vehicle type (#11892) +Fix #10438: [Script] Validate story page element type for ScriptStoryPage::NewElement (#11888) +Fix #9865: Removing files with the console always failed +Fix #9810: Rebuilding a through road stop costs money (#9852) +Fix #9722: Crash when pressing hotkeys early in world generation (#11858) +Fix #9697: Limit the default width of the Online Players window (#11936) +Fix #9642: Keep infrastructure totals when overbuilding road depots (#11229) +Fix #9545: Crash when all cargo types are disabled (#11432) +Fix #8846: When upgrading NewGRF presets, copy NewGRF parameters only if the NewGRF are compatible (#11348) +Fix #8253: Improve profit graph when having lots of money (#11915) +Fix #6377: Two tarballs with the same folder in them were considered as one (#11855) +Fix #5713: Ships could be sent to unreachable depots (#11768) +Fix #4575: Use Latin 'l' in English translation of zloty (#11090) +Fix #4415: Land info build date is also renovation date (#11759) +Fix: Display rank correctly with more than 15 companies in a league table (#11940) +Fix: Extra refit button when train/RV is in a depot (#11904) +Fix: Update server listing as offline when unexpected disconnect during refresh (#11891) +Fix: Horizontal scale of framerate window switched excessively (#11813) +Fix: [Linux] Various issues with resolutions and fullscreen in multi-display setups (#11778, #11779) +Fix: Build button text when train purchase window using "Engines" filter (#11755) +Fix: One-way state remained after removing road from road and tram tile (#11745) +Fix: Draw video driver info at the correct size and text wrap (#10716) +Fix: Language genders could not be applied to SCC_INDUSTRY_NAME (#11697) +Fix: Spurious cancellations of HTTP content downloads (#11668) +Fix: Calculation of initial engine age was inaccurate (#11660) +Fix: Prevent underflow if engine base life is less than 8 years (#11635) +Fix: Changing default livery did not propagate to group liveries (#11633) +Fix: Window width/height was doubly-scaled with automatic DPI switch (#11598) +Fix: Don't crash when saving a crashlog save with no main window open (#11586) +Fix: Prevent overflow when calculating max town noise (#11564) +Fix: Deleting towns did not check for waypoints referencing the town (#11513) +Fix: Invalidate playlist window when (un)shuffling playlist (#11504) +Fix: Restore original cargo legend 'blob' dimensions (#11480) +Fix: Extmidi did not move on to next song after playing ends (#11469) +Fix: Server password length in the UI was unnecessarily limited (#11408) +Fix: OpenTTD can fail to exit on an error due to mutex locks in threads (#11398) +Fix: Scale minimum width for server name by interface scale (#11381) +Fix: Server connection was not closed when relay window was closed (#11366) +Fix: Upgrading NewGRF presets could result in incomplete display of NewGRF parameters until restart (#11348) +Fix: Check for engine variant loops during NewGRF initialization (#11343) +Fix: Don't allow industries to produce invalid cargo (#11314) +Fix: Also apply cargo filters on shared groups in vehicle listing (#11294) +Fix: Only count distance traveled in vehicles for cargo payment (#11283) +Fix: Base cargo payment on load/unload tile, instead of station sign location (#11281) +Fix: Crash when opening a damaged base-graphics (#11275) +Fix: Trivial autoreplace of mixed cargo articulated engines (#11253) +Fix: [Emscripten] Config not saved on exit (#11248) +Fix: Inaccurate waiting cargo total in station window when using cargodist (#11213) +Fix: No fast forward in network was ensured only from GUI side (#11206) +Fix: Crash when not passing command-line parameter for -n (#11153) +Fix: [Bootstrap] Don't crash when failing to connect to content server (#11122) +Fix: Crash when failing to load a game into a dedicated server at startup (#11021) +Fix: Don't allow changing settings over the network that are marked as local settings (#11009) +Fix: Move no_http_content_downloads and use_relay_service to private settings (#10762) +Fix: Extra viewport could not be scrolled with right-click-close (#10644) +Fix: Specify units for value of share trading age setting (#10612) +Fix: Road type is not available before its introduction date (#10585) +Fix: Do not update a RV's Z-position when stationary while turning (#10570) +Fix: Don't (briefly) switch from title-only playlist on menu screen (#10553) +Fix: Reset content download progress to zero if falling back to TCP (#10485) +Fix: Make script goals work with the whole range of ClientIDs (#10435) +Fix: [NewGRF] Tile slope missing from road stops varact2 variable 0x42 (#11373) +Fix: [NewGRF] House class mappings were not reset between games (#11279) +Fix: [NewGRF] Profile didn't stop if there were no events yet (#10816) +Fix: [NewGRF] Support more than 256 stations/waypoints/roadstops per class (#10793) +Fix: [NewGRF] Var68 for station and roadstop was broken (#10784) +Fix: [NewGRF] Object and road stop ignore property handlers (#10525) +Fix: [Script] Apply random deviation to settings only at script start (#11944) +Fix: [Script] Improve ScriptText validation (#11721) +Fix: [Script] GSAdmin.Send() could generate invalid JSON (#11250) +Fix: [Script] Crash if squirrel compatibility scripts cannot be parsed (#11589) +Fix: [Script] Don't list unavailable road types for game scripts (#10585) +Fix: [Script] Game scripts were able to build with non-existing road types (#10539) +Fix: [Script] Inconsistent precondition failure return values (#10533) +Fix: [Script] Crash when companies disappear (#10529) +Fix: [Script] ScriptBase::Rand() return value could return negative values (#10443) +Fix: [Script] Incorrect value for GOAL_INVALID (#10436) +Fix: [Script] Extend Script::IsValidVehicle to check for primary vehicles (#10386) +Remove: "generation_seed" from config, as it was a write-only value (#11927) +Remove: Debug redirect over network (#11776) +Remove: Officially mark Vista as no longer supported (#11531) +Remove: OS/2 and SunOS ports (#11018, #11210) +Remove: Obsolete NewGRF text unprinting (#10884) +Remove: [Script] CONFIG_RANDOM from AddSetting flags (#11942) diff --git a/.dorpsgek.yml b/.dorpsgek.yml index 7ce84af7..4b09738b 100644 --- a/.dorpsgek.yml +++ b/.dorpsgek.yml @@ -8,7 +8,7 @@ notifications: only: - master only-by: - - DorpsGek + - eints-sync\[bot\] commit-comment: discussion: pull-request: diff --git a/.editorconfig b/.editorconfig index 787a1c76..7b001a85 100644 --- a/.editorconfig +++ b/.editorconfig @@ -7,3 +7,471 @@ trim_trailing_whitespace = true [*.{c,cpp,h,hpp}] indent_style = tab charset = utf-8 +#indent_size = +#tab_width = +#end_of_line = + +### C++ specific editor config rules ### +## Visual Studio ## https://learn.microsoft.com/en-us/visualstudio/ide/cpp-editorconfig-properties?view=vs-2019 ## +# Indentation # +# Do not indent braces +cpp_indent_braces = false +# When a new line is typed, it's indented relatively to the innermost open parenthesis +cpp_indent_multi_line_relative_to = innermost_parenthesis +# Indent new lines within parenthesis +cpp_indent_within_parentheses = indent +# In existing code, do not use the setting for alignment of new lines within parentheses +cpp_indent_preserve_within_parentheses = true +# Indent case contents +cpp_indent_case_contents = true +# Indent case labels +cpp_indent_case_labels = true +# Do not indent braces following a case statement +cpp_indent_case_contents_when_block = false +# Do not indent braces of lambdas used as parameters +cpp_indent_lambda_braces_when_parameter = false +# No override for "Position of goto labels" (Unspecified) +#cpp_indent_goto_labels +# Move preprocessor directives to the leftmost column +cpp_indent_preprocessor = leftmost_column +# Do not indent access specifiers +cpp_indent_access_specifiers = false +# Indent namespace contents +cpp_indent_namespace_contents = true +# Preserve indentation of comments +cpp_indent_preserve_comments = true + +# Newline # +# Keep open braces for namespaces on the same line, but add a space before the brace +cpp_new_line_before_open_brace_namespace = same_line +# Keep open braces for types/classes on the same line, but add a space before the brace +cpp_new_line_before_open_brace_type = same_line +# Move open braces for functions to a new line +cpp_new_line_before_open_brace_function = new_line +# Keep open braces for control blocks on the same line, but add a space before the brace +cpp_new_line_before_open_brace_block = same_line +# Keep open braces for lambdas on the same line, but add a space before the brace +cpp_new_line_before_open_brace_lambda = same_line +# Place scope braces on separate lines +cpp_new_line_scope_braces_on_separate_lines = true +# Do not move closing braces to the same line as opening braces for empty types +cpp_new_line_close_brace_same_line_empty_type = false +# Do not move closing braces to the same line as opening braces for empty function bodies +cpp_new_line_close_brace_same_line_empty_function = false +# Do not place 'catch' and similar keywords on a new line +cpp_new_line_before_catch = false +# Do not place 'else' on a new line +cpp_new_line_before_else = false +# Do not place 'while' in a do-while loop on a new line +cpp_new_line_before_while_in_do_while = false + +# Spacing # +# Remove spaces between function names and opening parentheses of argument lists +cpp_space_before_function_open_parenthesis = remove +# Do not insert a space within parentheses of an argument list +cpp_space_within_parameter_list_parentheses = false +# Do not insert a space between parentheses when argument list is empty +cpp_space_between_empty_parameter_list_parentheses = false +# Insert space between keyword and opening parenthesis in control flow statements +cpp_space_after_keywords_in_control_flow_statements = true +# Do not insert a space within parentheses of a control statement +cpp_space_within_control_flow_statement_parentheses = false +# Do not insert a space before opening parenthesis of lambda argument lists +cpp_space_before_lambda_open_parenthesis = false +# Do not insert a space within parentheses of a C-style cast +cpp_space_within_cast_parentheses = false +# Do not insert a space after closing parenthesis of C-style cast +cpp_space_after_cast_close_parenthesis = false +# Do not insert a space within parentheses of a parenthesized expression +cpp_space_within_expression_parentheses = false +# Insert space before opening brace of blocks +cpp_space_before_block_open_brace = true +# Do not insert a space between empty braces +cpp_space_between_empty_braces = false +# Do not insert a space before opening brace of uniform initialization and initializer lists +cpp_space_before_initializer_list_open_brace = false +# No override for "Insert space within braces of uniform initialization and initializer lists" (Spacing for this varies) +#cpp_space_within_initializer_list_braces +# Preserve spaces inside uniform initialization and initializer lists +cpp_space_preserve_in_initializer_list = true +# Do not insert space before opening square brackets +cpp_space_before_open_square_bracket = false +# Do not insert space within square bracket +cpp_space_within_square_brackets = false +# Do not insert space before empty square brackets +cpp_space_before_empty_square_brackets = false +# Do not insert space between empty square brackets +cpp_space_between_empty_square_brackets = false +# Group square brackets for multi-dimensional arrays together +cpp_space_group_square_brackets = true +# Do not insert space within square brackets for lambdas +cpp_space_within_lambda_brackets = false +# Do not insert space between empty lambda brackets +cpp_space_between_empty_lambda_brackets = false +# Do not insert space before commas +cpp_space_before_comma = false +# Insert space after commas +cpp_space_after_comma = true +# Remove spaces before and after member operators +cpp_space_remove_around_member_operators = true +# Insert space before colon for base in type declarations +cpp_space_before_inheritance_colon = true +# Insert space before colon for constructors +cpp_space_before_constructor_colon = true +# Remove space before semicolons +cpp_space_remove_before_semicolon = true +# No override for "Insert space after semicolons" (Depends on if loop is unconditional) +#cpp_space_after_semicolon +# Remove spaces between unary operators and their operands +cpp_space_remove_around_unary_operator = true +# Insert spaces before and after binary operators +cpp_space_around_binary_operator = insert +# Insert spaces around assignment operators +cpp_space_around_assignment_operator = insert +# Align pointer/reference symbol to the right +cpp_space_pointer_reference_alignment = right +# Insert spaces around conditional operators +cpp_space_around_ternary_operator = insert + +# Wrapping # +# Always apply New Lines settings for blocks +cpp_wrap_preserve_blocks = never + + + +## Rider & ReSharper ## https://www.jetbrains.com/help/resharper/EditorConfig_CPP_CppBlankLinesPageScheme.html ## +# Blank Lines # +# No override for "Max blank lines in declarations" (Unspecified; Not consistent across source code) +#cpp_keep_blank_lines_in_declarations +# No override for "Max blank lines in rest of source code" (Unspecified; Not consistent across source code) +#cpp_keep_blank_lines_in_code +# No override for "Number of blank lines around class/struct/enum definition" (Unspecified; Not consistent across source code) +#cpp_blank_lines_around_class_definition +# No override for "Number of blank lines around function declarations" (Unspecified; Not consistent across source code) +#cpp_blank_lines_around_function_declaration +# No override for "Number of blank lines around function definitions" (Unspecified; Not consistent across source code) +#cpp_blank_lines_around_function_definition +# No override for "Number of blank lines around single line function definitions" (Unspecified; Not consistent across source code) +#cpp_blank_lines_around_single_line_function_definition +# No override for "Number of blank lines around namespaces" (Unspecified; Not consistent across source code) +#cpp_blank_lines_around_namespace +# No override for "Number of blank lines around other definitions and declarations" (Unspecified; Not consistent across source code) +#cpp_blank_lines_around_other_declaration + +# Braces Layout # +# Keep open braces for namespace declarations on the same line, but add a space before the brace +cpp_namespace_declaration_braces = end_of_line +# Keep open braces for linkage declarations on the same line, but add a space before the brace +cpp_linkage_specification_braces = end_of_line +# Keep open braces for types/classes on the same line, but add a space before the brace +cpp_type_declaration_braces = end_of_line +# Keep open braces for namespace definitions on the same line (does not modify spacing before the brace) +cpp_place_namespace_definitions_on_same_line = true +# Move open braces for functions to a new line +cpp_invocable_declaration_braces = next_line +# Keep open braces for lambdas on the same line, but add a space before the brace +cpp_anonymous_method_declaration_braces = end_of_line +# Keep open braces for case blocks on the same line, but add a space before the brace +cpp_case_block_braces = end_of_line +# No override for "Requires expression braces" style (requires expressions are a C++20 feature) +#cpp_requires_expression_braces +# Keep open braces for all other blocks on the same line, but add a space before the brace +cpp_other_braces = end_of_line +# Only indent the insides of multi-line expression braces +cpp_expression_braces = inside +# Place the braces of empty blocks together and on the same line +cpp_empty_block_style = together_same_line +# Force line breaks within simple compound statements +cpp_simple_block_style = line_break +# No override for "Regular expression for macros starting a block" (Marco blocks aren't used) +#cpp_macro_block_begin +# No override for "Regular expression for macros ending a block" (Marco blocks aren't used) +#cpp_macro_block_end + +# Tabs and indents # +# Redundant override (Already overriden globally by 'indent_style') +#cpp_indent_style +# Redundant override (Already overriden globally by 'indent_size') +#cpp_indent_size +# Redundant override (Already overriden globally by 'tab_width') +#cpp_tab_width +# Use spaces instead of tabs as indentation for precise alignment +cpp_alignment_tab_fill_style = use_spaces +# Allow alignment even if construct is located too far to the right, more than 2/3 of 'Hard wrap at' limit +cpp_allow_far_alignment = true + +# Indentation and Alignment # +# No override for "Continuous line indent" (Varies throughout source code) +#cpp_continuous_line_indent +# Do not use continuous line indent in function declaration and invocation parentheses +cpp_use_continuous_line_indent_in_method_pars = false +# Do not use continuous line indent in initializer lists +cpp_use_continuous_line_indent_in_expression_braces = false +# Indent namespace members (including nested ones) +cpp_namespace_indentation = all +# No override for "Indent linkage specification block members" (Unspecified) +#cpp_linkage_specification_indentation +# Do not indent access specifier from class +cpp_indent_access_specifiers_from_class = false +# Indent class member from access specifier +cpp_indent_class_members_from_access_specifiers = true +# Do not indent if a function definition or declaration is wrapped after the type +cpp_indent_wrapped_function_names = false +# Indent 'case' labels from 'switch' +cpp_indent_switch_labels = true +# No override for "Indent function declarations' parentheses" (Varies throughout source code) +#cpp_indent_method_decl_pars +# No override for "Indent method calls' parentheses" (Varies throughout source code) +#cpp_indent_invocation_pars +# No override for "Indent statement (if, while, for, etc) parentheses" (Varies throughout source code) +#cpp_indent_statement_pars +# Do not change preprocessor directives indenting +cpp_indent_preprocessor_directives = do_not_change +# No override for "Indent C++/CLI generic constraints" (C++/CLI is not used) +#cpp_indent_type_constraints +# Align/indent comments started at the first column +cpp_indent_comment = true +# Comments that comment out code will use the indentation level of the commented code. +cpp_place_comments_at_first_column = false +# Align multiline declarators in declaration +cpp_align_multiple_declaration = true +# Align multiline function parameters +cpp_align_multiline_parameter = true +# Align multiline call arguments +cpp_align_multiline_argument = true +# Do not align first of multiline call arguments with the opening parentheses +cpp_align_first_arg_by_paren = false +# Align multiline initializer list arguments +cpp_align_multiline_expression_brace = true +# No override for "Align multiline template parameters in template declaration" (Unspecified) +#cpp_align_multiline_type_parameter +# No override for "Align multiline template arguments" (Unspecified) +#cpp_align_multiline_type_argument +# Align multiline base classes in class base clause +cpp_align_multiline_extends_list = true +# Align multiline member initializers in member initializer lists +cpp_align_multiline_ctor_init = true +# Outdent commas placed on new line +cpp_outdent_commas = true +# Do not align multiline ?: operator with first line (since alignment is incorrect) +cpp_align_ternary = none +# Do not indent aligned ?: operator (since indentation varies) +cpp_indent_aligned_ternary = false +# No override for "Align multiline chained method calls" (Unspecified) +#cpp_align_multiline_calls_chain +# No override for "Outdent '.' and '->' in chained method calls on new lines" (Unspecified) +#cpp_outdent_dots +# Do not align multiline chained binary expressions +cpp_align_multiline_binary_expressions_chain = false +# Fix column alignment in adjacent lines +cpp_int_align_fix_in_adjacent = true +# Align assignments with adjacent assignments +cpp_int_align_eq = true +# Do not align declaration names with adjacent declaration names +cpp_int_align_declaration_names = false +# Align end-of-line comments with adjacent end-of-line comments +cpp_int_align_comments = true + +# Spaces # +# Do not put space before ANY commas +cpp_space_before_comma = false +# Put space after ALL commas +cpp_space_after_comma = true +# Put space before ptr in declaration of variable +cpp_space_before_ptr_in_data_member = true +# Do not put space after ptr in declaration of variable +cpp_space_after_ptr_in_data_member = false +# Put space before ptr in declaration of multiple variables +cpp_space_before_ptr_in_data_members = true +# Do not put space after ptr in declaration of multiple variables +cpp_space_after_ptr_in_data_members = false +# Put space before ptr in return type of function +cpp_space_before_ptr_in_method = true +# Do not put space after ptr in return type of function +cpp_space_after_ptr_in_method = false +# Do not put space before ptr in abstract declaration +cpp_space_before_ptr_in_abstract_decl = false +# Put space before ref in declaration of variable +cpp_space_before_ref_in_data_member = true +# Do not put space after ref in declaration of variable +cpp_space_after_ref_in_data_member = false +# Put space before ref in declaration of multiple variables +cpp_space_before_ref_in_data_members = true +# Do not put space after ref in declaration of multiple variables +cpp_space_after_ref_in_data_members = false +# Do not put space before ref in return type of function +cpp_space_before_ref_in_method = false +# Put space after ref in return type of function +cpp_space_after_ref_in_method = true +# Do not put space before ref in abstract declaration +cpp_space_before_ref_in_abstract_decl = false +# Do not put space before parentheses in function parameters +cpp_space_between_method_declaration_name_and_open_parenthesis = false +# Do not put space before parentheses in lambda parameters +cpp_space_before_lambda_parentheses = false +# Do not put space within parentheses in function parameters +cpp_space_between_method_declaration_parameter_list_parentheses = false +# Do not put space within empty parentheses in function parameters +cpp_space_between_method_declaration_empty_parameter_list_parentheses = false +# Do not put space before angle brackets in template parameters +cpp_space_before_template_params = false +# Do not put space within angle brackets in template parameters +cpp_space_within_template_params = false +# Do not put space within empty angle brackets in template parameters +cpp_space_within_empty_template_params = false +# Do not put space before angle brackets in template arguments +cpp_space_before_template_args = false +# Do not put space within angle brackets in template arguments +cpp_space_within_template_args = false +# Do not put space between closing angle brackets in template arguments +cpp_space_between_closing_angle_brackets_in_template_args = false +# Put space around '=' in alias declaration and namespace alias +cpp_space_around_alias_eq = true +# Do not put space around '->' in trailing return types +cpp_space_around_deref_in_trailing_return_type = false +# Put space before base types list colon +cpp_space_before_colon_in_inheritance_clause = true +# Put space after base types list colon +cpp_space_after_colon_in_inheritance_clause = true +# No override for "Before C++/CLI generic constraint colon" (Unspecified) +#cpp_space_before_type_parameter_constraint_colon +# No override for "After C++/CLI generic constraint colon" (Unspecified) +#cpp_space_after_type_parameter_constraint_colon +# Put space before parentheses of control statements +cpp_space_after_keywords_in_control_flow_statements = true +# Do not put space within parentheses of control statements +cpp_space_between_parentheses_of_control_flow_statements = false +# Do not put space before semicolon in 'for' statements +cpp_space_before_semicolon_in_for_statement = false +# Put space after semicolon in 'for' statements +cpp_space_after_semicolon_in_for_statement = true +# Put space before ':' in range-based for loop +cpp_space_before_for_colon = true +# Put space after ':' in range-based for loop +cpp_space_after_for_colon = true +# Do not put space before colon in switch case or label statement +cpp_space_before_colon_in_case = false +# Put space after colon in switch case or label statement +cpp_space_after_colon_in_case = true +# Put space around binary operator +cpp_space_around_binary_operator = true +# Put space around assignment operator +cpp_space_around_assignment_operator = true +# Do not put space around dot, '->', '.*' and '->.' +cpp_space_around_member_access_operator = false +# Do not put space within any parentheses +cpp_space_within_parentheses = false +# Do not put space before array subscript brackets +cpp_space_before_open_square_brackets = false +# Do not put space within array subscript brackets +cpp_space_between_square_brackets = false +# Do not put space before empty parentheses in function call and initialization +cpp_space_between_method_call_name_and_opening_parenthesis = false +# Do not put space within parentheses in cast expressions +cpp_space_between_typecast_parentheses = false +# Do not put space after parentheses in cast expressions +cpp_space_after_cast = false +# Do not put space within parentheses in function call and initialization +cpp_space_between_method_call_parameter_list_parentheses = false +# Do not put space within empty parentheses in function call and initialization +cpp_space_between_method_call_empty_parameter_list_parentheses = false +# Put space in ternary operator '? :' before '?' +cpp_space_before_ternary_quest = true +# Put space in ternary operator '? :' after '?' +cpp_space_after_ternary_quest = true +# Put space in ternary operator '? :' before ':' +cpp_space_before_ternary_colon = true +# Put space in ternary operator '? :' after ':' +cpp_space_after_ternary_colon = true +# Do not put space before uniform initialization braces +cpp_space_before_initializer_braces = false +# Do not put space within uniform initialization braces +cpp_space_within_initializer_braces = false +# Do not put space within empty uniform initialization braces +cpp_space_within_empty_initializer_braces = false +# Put space before end of line comment +cpp_space_before_trailing_comment = true +# Preserve spaces before end of line comment +cpp_disable_space_changes_before_trailing_comment = true + +# Line breaks and Wrapping # +# Redundant override (Already overriden globally by 'insert_final_newline') +#cpp_insert_final_newline +# Redundant override (Already overriden earlier in Visual Studio section) +#cpp_new_line_before_else +# Do not place 'while' in a do-while loop on a new line +cpp_new_line_before_while = false +# Redundant override (Already overriden earlier in Visual Studio section) +#cpp_new_line_before_catch +# Do not change the line breaks of single embedded statements +cpp_simple_embedded_statement_style = do_not_change +# Do not change the line breaks of simple 'case' statement +cpp_simple_case_statement_style = do_not_change +# Put member function definition return type on same line +cpp_function_definition_return_type_style = on_single_line +# Put top-level function definition return type on same line +cpp_toplevel_function_definition_return_type_style = on_single_line +# Put member function declaration return type on same line +cpp_function_declaration_return_type_style = on_single_line +# Put top-level function declaration return type on same line +cpp_toplevel_function_declaration_return_type_style = on_single_line +# Force template<...> of a template declaration on new line +cpp_break_template_declaration = line_break +# No override for "Break line before the requires-clause" (requires-clause is a C++20 feature) +#cpp_line_break_before_requires_clause +# Do not change the line break before the colon in member initializer lists +cpp_member_initializer_list_style = do_not_change +# Do not change the line break after the colon in member initializer lists +cpp_line_break_after_colon_in_member_initializer_lists = do_not_change +# No override for "Break line before comma in member initializer lists" (Varies throughout source code) +#cpp_line_break_before_comma_in_member_initializer_lists +# No override for "Break line after comma in member initializer lists" (Varies throughout source code) +#cpp_line_break_after_comma_in_member_initializer_lists +# No override for "Allow C++/CLI generic constraints on the same line" (C++/CLI is not used) +#cpp_place_type_constraints_on_same_line +# No override for "Keep existing line breaks" (Varies throughout source code; depends on developer preference) +#cpp_keep_user_linebreaks +# No override for "Hard wrap at _ characters" (Unspecified) +#cpp_max_line_length +# Do not prefer wrap before ',' +cpp_wrap_before_comma = false +# Do not prefer wrap before ',' in base clause +cpp_wrap_before_comma_in_base_clause = false +# No override for "Wrap ternary expression" (Varies throughout source code) +#cpp_wrap_ternary_expr_style +# No override for "Prefer wrap before '?' and ':' in ternary expressions" (Varies throughout source code) +#cpp_wrap_before_ternary_opsigns +# No override for "Prefer wrap before ':'" (Varies throughout source code) +#cpp_wrap_before_colon +# No override for "Prefer wrap before first C++/CLI generic constraint" (C++/CLI is not used) +#cpp_wrap_before_first_type_parameter_constraint +# No override for "Wrap multiple C++/CLI generic constraints" (C++/CLI is not used) +#cpp_wrap_multiple_type_parameter_constraints_style +# No override for "Wrap enum definition" (Varies throughout source code) +#cpp_wrap_enumeration_style +# No override for "Wrap braced initializer list" (Varies throughout source code) +#cpp_wrap_braced_init_list_style +# No override for "Wrap base classes list" (Varies throughout source code) +#cpp_wrap_base_clause_style +# No override for "Wrap constructor initializer" (Varies throughout source code) +#cpp_wrap_ctor_initializer_style +# No override for "Wrap formal parameters" (Varies throughout source code) +#cpp_wrap_parameters_style +# Do not prefer wrap before '(' in declaration +cpp_wrap_before_declaration_lpar = false +# Prefer wrap after '(' in declaration +cpp_wrap_after_declaration_lpar = true +# Do not prefer wrap before ')' in declaration +cpp_wrap_before_declaration_rpar = false +# No override for "Wrap invocation arguments" (Varies throughout source code) +#cpp_wrap_arguments_style +# Do not prefer wrap before '(' in invocation +cpp_wrap_before_invocation_lpar = false +# Prefer wrap after '(' in invocation +cpp_wrap_after_invocation_lpar = true +# Do not prefer wrap before ')' in invocation +cpp_wrap_before_invocation_rpar = false +# Prefer wrap after '{' in initializer lists +cpp_wrap_after_expression_lbrace = true +# Do not prefer wrap before '}' in initializer lists +cpp_wrap_before_expression_rbrace = false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aec09828..a492089f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -42,7 +42,7 @@ Some things are not automated, and forgotten often. This list is a reminder for * This PR touches english.txt or translations? Check the [guidelines](https://github.com/OpenTTD/OpenTTD/blob/master/docs/eints.md) * This PR affects the save game format? (label 'savegame upgrade') * This PR affects the GS/AI API? (label 'needs review: Script API') - * ai_changelog.hpp, gs_changelog.hpp need updating. + * ai_changelog.hpp, game_changelog.hpp need updating. * The compatibility wrappers (compat_*.nut) need updating. * This PR affects the NewGRF API? (label 'needs review: NewGRF') * newgrf_debug_data.h may need updating. diff --git a/.github/codeql/codeql-config.yml b/.github/codeql/codeql-config.yml new file mode 100644 index 00000000..b5fd9c58 --- /dev/null +++ b/.github/codeql/codeql-config.yml @@ -0,0 +1,12 @@ +name: openttd +queries: +- uses: security-and-quality +query-filters: +- exclude: + id: + # Only feasible way is to move away from fopen; fopen_s is optional C11 and not implemented on most platforms. + - cpp/world-writable-file-creation + # Basically OpenTTD's coding style for adding things like ..._INVALID to enumerations + - cpp/irregular-enum-init + # Our GUI code tends to use switches for OnClick handlers, DrawWidget, and UpdateWidgetSize. Sometimes GUIs just don't have many elements, but we want to keep consistency. + - cpp/trivial-switch diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..d97e3157 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: +- package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" + groups: + actions: + patterns: + - "*" diff --git a/.github/script-missing-mode-enforcement.py b/.github/script-missing-mode-enforcement.py new file mode 100644 index 00000000..dfb4764a --- /dev/null +++ b/.github/script-missing-mode-enforcement.py @@ -0,0 +1,71 @@ +""" +Script to scan the OpenTTD's script API for functions that miss checks for the +function being called from the right mode (deity or company mode). + +When a function calls either ScriptObject::Command or ScriptObject::GetCompany +then the function is considered dangerous. When one of the mode enforcement +macros from script_error.hpp, i.e. EnforceDeityMode, EnforceCompanyModeValid or +EnforceDeityOrCompanyModeValid, are called in the function, then we consider +that the function has mode enforcement. + +Any dangerous function for which no enforcement is found are emitted as errors. +""" + +import glob +import re +import sys + + +def check_mode_enforcement(path): + errors = [] + with open(path, "r") as reader: + mode_enforcement_found = False + dangerous_function = False + for line in reader: + # Line does not start with a tab and have ::. That looks like the begin of a function, so reset the state. + if re.match(r"^[^\t].*\w::\w", line): + mode_enforcement_found = False + dangerous_function = False + currentFunction = line + continue + + if re.match( + r"\t(EnforceDeityMode|EnforceCompanyModeValid|EnforceCompanyModeValid_Void|EnforceDeityOrCompanyModeValid|EnforceDeityOrCompanyModeValid_Void)\(", + line, + ): + # Mode enforcement macro found + mode_enforcement_found = True + continue + + if re.match(r".*(ScriptObject::Command|ScriptObject::GetCompany).*", line): + # Dangerous function found + dangerous_function = True + continue + + # Line with only a closing bracket. That looks like the end of a function, so check for the dangerous function without mode enforcement + if re.match(r"^}$", line) and dangerous_function and not mode_enforcement_found: + function_name = currentFunction.rstrip("\n").replace("/* static */ ", "") + errors.append(f"{path}: {function_name}") + + return errors + + +def main(): + errors = [] + for path in sorted(glob.glob("src/script/api/*.cpp")): + # Skip a number of files that yield only false positives + if path.endswith(("script_object.cpp", "script_companymode.cpp", "script_controller.cpp", "script_game.cpp")): + continue + + errors.extend(check_mode_enforcement(path)) + + if errors: + print("Mode enforcement was expected in the following files/functions:") + print("\n".join(errors)) + sys.exit(1) + + print("OK") + + +if __name__ == "__main__": + main() diff --git a/.github/unused-strings.py b/.github/unused-strings.py index 210212c3..527a938d 100644 --- a/.github/unused-strings.py +++ b/.github/unused-strings.py @@ -210,11 +210,10 @@ def main(): errors.append(f"ERROR: {string} is (possibly) no longer needed.") if errors: - for error in errors: - print(error) + print("\n".join(errors)) sys.exit(1) - else: - print("OK") + + print("OK") if __name__ == "__main__": diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml index ee372844..2183044d 100644 --- a/.github/workflows/ci-build.yml +++ b/.github/workflows/ci-build.yml @@ -9,6 +9,10 @@ on: env: CTEST_OUTPUT_ON_FAILURE: 1 +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + jobs: emscripten: name: Emscripten @@ -16,17 +20,17 @@ jobs: runs-on: ubuntu-20.04 container: # If you change this version, change the number in the cache step too. - image: emscripten/emsdk:3.1.28 + image: emscripten/emsdk:3.1.42 steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup cache - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: /emsdk/upstream/emscripten/cache - key: 3.1.28-${{ runner.os }} + key: 3.1.42-${{ runner.os }} - name: Patch Emscripten to support LZMA run: | @@ -61,37 +65,56 @@ jobs: echo "::group::Build" echo "Running on $(nproc) cores" - cmake --build . -j $(nproc) + cmake --build . -j $(nproc) --target openttd echo "::endgroup::" linux: - name: Linux - strategy: fail-fast: false matrix: include: - - compiler: clang - cxxcompiler: clang++ - libsdl: libsdl2-dev - - compiler: gcc + - name: Clang - Debug + compiler: clang-15 + cxxcompiler: clang++-15 + libraries: libsdl2-dev + - name: Clang - Release + compiler: clang-15 + cxxcompiler: clang++-15 + libraries: libsdl2-dev + extra-cmake-parameters: -DCMAKE_BUILD_TYPE=RelWithDebInfo -DOPTION_USE_ASSERTS=OFF + - name: GCC - SDL2 + compiler: gcc cxxcompiler: g++ - libsdl: libsdl2-dev - - compiler: gcc + libraries: libsdl2-dev + - name: GCC - SDL1.2 + compiler: gcc cxxcompiler: g++ - libsdl: libsdl1.2-dev - - compiler: gcc + libraries: libsdl1.2-dev + - name: GCC - Dedicated + compiler: gcc cxxcompiler: g++ - extra-cmake-parameters: -DOPTION_DEDICATED=ON -DCMAKE_CXX_FLAGS_INIT="-DRANDOM_DEBUG" + libraries: grfcodec + extra-cmake-parameters: -DOPTION_DEDICATED=ON -DCMAKE_CXX_FLAGS_INIT="-DRANDOM_DEBUG" -DCMAKE_DISABLE_PRECOMPILE_HEADERS=ON + # Compile without SDL / SDL2, as that should compile fine too. - runs-on: ubuntu-20.04 + name: Linux (${{ matrix.name }}) + + runs-on: ubuntu-latest env: CC: ${{ matrix.compiler }} CXX: ${{ matrix.cxxcompiler }} steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 + + - name: Setup vcpkg caching + uses: actions/github-script@v7 + with: + script: | + core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); + core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); + core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite') - name: Install dependencies run: | @@ -102,13 +125,25 @@ jobs: echo "::group::Install dependencies" sudo apt-get install -y --no-install-recommends \ liballegro4-dev \ + libcurl4-openssl-dev \ libfontconfig-dev \ + libharfbuzz-dev \ libicu-dev \ liblzma-dev \ liblzo2-dev \ - ${{ matrix.libsdl }} \ + ${{ matrix.libraries }} \ zlib1g-dev \ # EOF + + echo "::group::Install vcpkg dependencies" + + # Disable vcpkg integration, as we mostly use system libraries. + mv vcpkg.json vcpkg-disabled.json + + # We only use breakpad from vcpkg, as its CMake files + # are a bit special. So the Ubuntu's variant doesn't work. + vcpkg install breakpad + echo "::endgroup::" env: DEBIAN_FRONTEND: noninteractive @@ -137,7 +172,7 @@ jobs: cd build echo "::group::CMake" - cmake .. ${{ matrix.extra-cmake-parameters }} + cmake .. -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake ${{ matrix.extra-cmake-parameters }} echo "::endgroup::" echo "::group::Build" @@ -147,12 +182,18 @@ jobs: - name: Test run: | - cd build - ctest -j $(nproc) --timeout 120 + ( + cd build + ctest -j $(nproc) --timeout 120 + ) - macos: - name: Mac OS + # Re-enable vcpkg. + mv vcpkg-disabled.json vcpkg.json + + # Check no tracked files have been modified. + git diff --exit-code + macos: strategy: fail-fast: false matrix: @@ -160,49 +201,28 @@ jobs: - arch: x64 full_arch: x86_64 + name: Mac OS (${{ matrix.arch }}) + runs-on: macos-latest env: MACOSX_DEPLOYMENT_TARGET: 10.13 steps: - name: Checkout - uses: actions/checkout@v3 - - - name: Install dependencies - env: - HOMEBREW_NO_AUTO_UPDATE: 1 - HOMEBREW_NO_INSTALL_CLEANUP: 1 - run: | - brew install \ - pkg-config \ - # EOF + uses: actions/checkout@v4 - - name: Prepare cache key - id: key - run: | - echo "image=$ImageOS-$ImageVersion" >> $GITHUB_OUTPUT - - - name: Enable vcpkg cache - uses: actions/cache@v3 + - name: Setup vcpkg caching + uses: actions/github-script@v7 with: - path: /usr/local/share/vcpkg/installed - key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-0 # Increase the number whenever dependencies are modified - restore-keys: | - ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }} - - - name: Prepare vcpkg - run: | - vcpkg install --triplet=${{ matrix.arch }}-osx \ - liblzma \ - libpng \ - lzo \ - zlib \ - # EOF + script: | + core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); + core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); + core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite') - name: Install OpenGFX run: | mkdir -p ~/Documents/OpenTTD/baseset - cd ~/Documents//OpenTTD/baseset + cd ~/Documents/OpenTTD/baseset echo "::group::Download OpenGFX" curl -L https://cdn.openttd.org/opengfx-releases/0.6.0/opengfx-0.6.0-all.zip -o opengfx-all.zip @@ -223,7 +243,7 @@ jobs: cd build echo "::group::CMake" - cmake ${GITHUB_WORKSPACE} \ + cmake .. \ -DCMAKE_OSX_ARCHITECTURES=${{ matrix.full_arch }} \ -DVCPKG_TARGET_TRIPLET=${{ matrix.arch }}-osx \ -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \ @@ -241,46 +261,27 @@ jobs: ctest -j $(sysctl -n hw.logicalcpu) --timeout 120 windows: - name: Windows - strategy: fail-fast: false matrix: os: [windows-latest, windows-2019] arch: [x86, x64] + name: Windows (${{ matrix.os }} / ${{ matrix.arch }}) + runs-on: ${{ matrix.os }} steps: - name: Checkout - uses: actions/checkout@v3 - - - name: Prepare cache key - id: key - shell: powershell - run: | - # Work around caching failure with GNU tar - New-Item -Type Junction -Path vcpkg -Target c:\vcpkg - - Write-Output "image=$env:ImageOS-$env:ImageVersion" >> $env:GITHUB_OUTPUT + uses: actions/checkout@v4 - - name: Enable vcpkg cache - uses: actions/cache@v3 + - name: Setup vcpkg caching + uses: actions/github-script@v7 with: - path: vcpkg/installed - key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-0 # Increase the number whenever dependencies are modified - restore-keys: | - ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }} - - - name: Prepare vcpkg - shell: bash - run: | - vcpkg install --triplet=${{ matrix.arch }}-windows-static \ - liblzma \ - libpng \ - lzo \ - zlib \ - # EOF + script: | + core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); + core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); + core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite') - name: Install OpenGFX shell: bash @@ -308,6 +309,8 @@ jobs: - name: Build shell: bash + env: + NINJA_STATUS: "[%f/%t -- %e] " # [finished_edges/total_edges -- elapsed_time], default value is "[%f/%t] " run: | mkdir build cd build @@ -327,13 +330,11 @@ jobs: - name: Test shell: bash run: | - cd ${GITHUB_WORKSPACE}/build + cd build ctest --timeout 120 msys2: - name: msys2 - strategy: fail-fast: false matrix: @@ -343,11 +344,13 @@ jobs: - msystem: MINGW32 arch: i686 + name: MinGW (${{ matrix.arch }}) + runs-on: windows-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup MSYS2 uses: msys2/setup-msys2@v2 @@ -361,6 +364,8 @@ jobs: mingw-w64-${{ matrix.arch }}-gcc mingw-w64-${{ matrix.arch }}-lzo2 mingw-w64-${{ matrix.arch }}-libpng + mingw-w64-${{ matrix.arch }}-lld + mingw-w64-${{ matrix.arch }}-ninja - name: Install OpenGFX shell: bash @@ -383,24 +388,28 @@ jobs: - name: Build shell: msys2 {0} + env: + NINJA_STATUS: "[%f/%t -- %e] " # [finished_edges/total_edges -- elapsed_time], default value is "[%f/%t] " run: | mkdir build cd build echo "::group::CMake" - cmake .. -G"MSYS Makefiles" + cmake .. \ + -GNinja \ + -DCMAKE_CXX_FLAGS="-fuse-ld=lld" \ + # EOF echo "::endgroup::" echo "::group::Build" - echo "Running on $(nproc) cores" - cmake --build . -j $(nproc) + cmake --build . echo "::endgroup::" - name: Test shell: msys2 {0} run: | cd build - ctest -j $(nproc) --timeout 120 + ctest --timeout 120 check_annotations: name: Check Annotations @@ -417,4 +426,4 @@ jobs: steps: - name: Check annotations - uses: OpenTTD/actions/annotation-check@v3 + uses: OpenTTD/actions/annotation-check@v5 diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 00000000..c5a432d8 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,85 @@ +name: CodeQL + +on: + push: + branches: + - master + pull_request: + # The branches below must be a subset of the branches above + branches: + - master + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Install dependencies + run: | + echo "::group::Update apt" + sudo apt-get update + echo "::endgroup::" + + echo "::group::Install dependencies" + sudo apt-get install -y --no-install-recommends \ + liballegro4-dev \ + libcurl4-openssl-dev \ + libfontconfig-dev \ + libharfbuzz-dev \ + libicu-dev \ + liblzma-dev \ + liblzo2-dev \ + libsdl2-dev \ + zlib1g-dev \ + # EOF + echo "::endgroup::" + env: + DEBIAN_FRONTEND: noninteractive + + - name: Set number of make jobs + run: | + echo "MAKEFLAGS=-j$(nproc)" >> $GITHUB_ENV + + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: cpp + config-file: ./.github/codeql/codeql-config.yml + + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 + with: + category: /language:cpp + upload: False + output: sarif-results + + - name: Filter out table & generated code + uses: advanced-security/filter-sarif@v1 + with: + patterns: | + +**/*.* + -**/table/*.* + -**/generated/**/*.* + -**/tests/*.* + input: sarif-results/cpp.sarif + output: sarif-results/cpp.sarif + + - name: Upload results + uses: github/codeql-action/upload-sarif@v3 + with: + sarif_file: sarif-results/cpp.sarif diff --git a/.github/workflows/commit-checker.yml b/.github/workflows/commit-checker.yml index 91fc54b1..319ab8a5 100644 --- a/.github/workflows/commit-checker.yml +++ b/.github/workflows/commit-checker.yml @@ -3,6 +3,10 @@ name: Commit checker on: pull_request: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + jobs: commit-checker: name: Commit checker @@ -10,12 +14,12 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 4 - name: Get pull-request commits - uses: OpenTTD/actions/checkout-pull-request@v2 + uses: OpenTTD/actions/checkout-pull-request@v5 - name: Check commits uses: OpenTTD/OpenTTD-git-hooks@main diff --git a/.github/workflows/preview-build.yml b/.github/workflows/preview-build.yml new file mode 100644 index 00000000..0bb79ed4 --- /dev/null +++ b/.github/workflows/preview-build.yml @@ -0,0 +1,103 @@ +name: Preview build + +on: + workflow_call: + secrets: + PREVIEW_CLOUDFLARE_API_TOKEN: + description: API token to upload a preview to Cloudflare Pages + required: true + PREVIEW_CLOUDFLARE_ACCOUNT_ID: + description: Account ID to upload a preview to Cloudflare Pages + required: true + +jobs: + preview: + name: Build preview + + environment: + name: preview + url: https://preview.openttd.org/pr${{ github.event.pull_request.number }}/ + + runs-on: ubuntu-latest + container: + # If you change this version, change the number in the cache step too. + image: emscripten/emsdk:3.1.42 + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + ref: ${{ github.event.pull_request.head.sha }} + + - name: Name branch + run: | + git config --global --add safe.directory ${GITHUB_WORKSPACE} + git checkout -b pr${{ github.event.pull_request.number }} + + - name: Setup cache + uses: actions/cache@v4 + with: + path: /emsdk/upstream/emscripten/cache + key: 3.1.42-${{ runner.os }} + + - name: Patch Emscripten to support LZMA + run: | + cd /emsdk/upstream/emscripten + patch -p1 < ${GITHUB_WORKSPACE}/os/emscripten/emsdk-liblzma.patch + + - name: Build (host tools) + run: | + mkdir build-host + cd build-host + + echo "::group::CMake" + cmake .. -DOPTION_TOOLS_ONLY=ON + echo "::endgroup::" + + echo "::group::Build" + echo "Running on $(nproc) cores" + make -j$(nproc) tools + echo "::endgroup::" + + - name: Install GCC problem matcher + uses: ammaraskar/gcc-problem-matcher@master + + - name: Build + run: | + mkdir build + cd build + + echo "::group::CMake" + emcmake cmake .. \ + -DHOST_BINARY_DIR=../build-host \ + -DCMAKE_BUILD_TYPE=Release \ + # EOF + echo "::endgroup::" + + echo "::group::Build" + echo "Running on $(nproc) cores" + cmake --build . -j $(nproc) --target openttd + echo "::endgroup::" + + - name: Prepare preview + run: | + mkdir public + + cp build/openttd.data public/ + cp build/openttd.html public/ + cp build/openttd.js public/ + cp build/openttd.wasm public/ + + # Ensure we use the latest version of npm; the one we get with current + # emscripten doesn't allow running "npx wrangler" as root. + # Current emscripten can't install npm>=10.0.0 because node is too old. + npm install -g npm@9 + + - name: Publish preview + uses: cloudflare/pages-action@v1 + with: + apiToken: ${{ secrets.PREVIEW_CLOUDFLARE_API_TOKEN }} + accountId: ${{ secrets.PREVIEW_CLOUDFLARE_ACCOUNT_ID }} + projectName: ${{ vars.PREVIEW_CLOUDFLARE_PROJECT_NAME }} + directory: public + branch: pr${{ github.event.pull_request.number }} diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml new file mode 100644 index 00000000..97ab3195 --- /dev/null +++ b/.github/workflows/preview.yml @@ -0,0 +1,20 @@ +name: Preview + +on: + pull_request_target: + types: + - labeled + - synchronize + branches: + - master + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number }} + cancel-in-progress: true + +jobs: + preview: + if: ${{ (github.event.action == 'labeled' && github.event.label.name == 'preview') || (github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'preview')) }} + name: Preview + uses: ./.github/workflows/preview-build.yml + secrets: inherit diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml index 759f3303..83868e52 100644 --- a/.github/workflows/release-docs.yml +++ b/.github/workflows/release-docs.yml @@ -15,7 +15,7 @@ jobs: steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source @@ -78,7 +78,7 @@ jobs: echo "::endgroup::" - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: openttd-docs path: build/bundles/*.tar.xz diff --git a/.github/workflows/release-linux.yml b/.github/workflows/release-linux.yml index 58394460..d3e0ea77 100644 --- a/.github/workflows/release-linux.yml +++ b/.github/workflows/release-linux.yml @@ -2,20 +2,26 @@ name: Release (Linux) on: workflow_call: + inputs: + survey_key: + required: false + type: string + default: "" jobs: linux: name: Linux (Generic) - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest container: - # manylinux2014 is based on CentOS 7, but already has a lot of things + # manylinux_2_28 is based on AlmaLinux 8, and already has a lot of things # installed and preconfigured. It makes it easier to build OpenTTD. - image: quay.io/pypa/manylinux2014_x86_64 + # This distro is based on glibc 2.28, released in 2018. + image: quay.io/pypa/manylinux_2_28_x86_64 steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source @@ -23,26 +29,37 @@ jobs: run: | tar -xf source.tar.gz --strip-components=1 - - name: Enable vcpkg cache - uses: actions/cache@v3 + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + + - name: Enable Rust cache + uses: Swatinem/rust-cache@v2 + + - name: Setup vcpkg caching + uses: actions/github-script@v7 with: - path: /vcpkg/installed - key: ubuntu-20.04-vcpkg-release-0 # Increase the number whenever dependencies are modified - restore-keys: | - ubuntu-20.04-vcpkg-release + script: | + core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); + core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); + core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite') - name: Install dependencies run: | echo "::group::Install system dependencies" - # ICU is used as vcpkg fails to install ICU. Other dependencies - # are needed either for vcpkg or for the packages installed with - # vcpkg. + # perl-IPC-Cmd, wget, and zip are needed to run vcpkg. + # autoconf-archive is needed to build ICU. yum install -y \ - libicu-devel \ + autoconf-archive \ perl-IPC-Cmd \ wget \ zip \ # EOF + + # aclocal looks first in /usr/local/share/aclocal, and if that doesn't + # exist only looks in /usr/share/aclocal. We have files in both that + # are important. So copy the latter to the first, and we are good to + # go. + cp /usr/share/aclocal/* /usr/local/share/aclocal/ echo "::endgroup::" # The yum variant of fluidsynth depends on all possible audio drivers, @@ -64,7 +81,6 @@ jobs: cmake --build . -j $(nproc) cmake --install . ) - echo "::endgroup::" echo "::group::Install audio drivers" # These audio libs are to make sure the SDL version of vcpkg adds @@ -72,42 +88,43 @@ jobs: # binary, but the headers are used to enable them in SDL. yum install -y \ alsa-lib-devel \ - jack-audio-connection-kit-devel \ pulseaudio-libs-devel \ # EOF echo "::endgroup::" + echo "::group::Install video drivers" + # These video libs are to make sure the SDL version of vcpkg adds + # video-support; these libraries are not added to the resulting + # binary, but the headers are used to enable them in SDL. + yum install -y \ + libX11-devel \ + libXcursor-devel \ + libXext-devel \ + libXfixes-devel \ + libXi-devel \ + libxkbcommon-devel \ + libXrandr-devel \ + libXScrnSaver-devel \ + mesa-libEGL-devel \ + mesa-libGL-devel \ + mesa-libGLES-devel \ + wayland-devel \ + wayland-protocols-devel \ + # EOF + echo "::endgroup::" + # We use vcpkg for our dependencies, to get more up-to-date version. echo "::group::Install vcpkg and dependencies" - # We do a little dance to make sure we copy the cached install folder - # into our new clone. - git clone --depth=1 https://github.com/microsoft/vcpkg /vcpkg-clone - if [ -e /vcpkg/installed ]; then - mv /vcpkg/installed /vcpkg-clone/ - rm -rf /vcpkg - fi - mv /vcpkg-clone /vcpkg + git clone https://github.com/microsoft/vcpkg /vcpkg ( cd /vcpkg ./bootstrap-vcpkg.sh -disableMetrics - - # Make Python3 available for other packages. - ./vcpkg install python3 - ln -sf $(pwd)/installed/x64-linux/tools/python3/python3.[0-9][0-9] /usr/bin/python3 - - ./vcpkg install \ - curl[http2] \ - fontconfig \ - freetype \ - liblzma \ - libpng \ - lzo \ - sdl2 \ - zlib \ - # EOF ) + + echo "::group::Install breakpad dependencies" + cargo install dump_syms echo "::endgroup::" - name: Install GCC problem matcher @@ -122,15 +139,21 @@ jobs: cmake ${GITHUB_WORKSPACE} \ -DCMAKE_TOOLCHAIN_FILE=/vcpkg/scripts/buildsystems/vcpkg.cmake \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \ -DOPTION_PACKAGE_DEPENDENCIES=ON \ # EOF echo "::endgroup::" echo "::group::Build" echo "Running on $(nproc) cores" - cmake --build . -j $(nproc) + cmake --build . -j $(nproc) --target openttd echo "::endgroup::" + - name: Create breakpad symbols + run: | + cd build + dump_syms ./openttd --inlines --store symbols + - name: Create bundles run: | cd ${GITHUB_WORKSPACE}/build @@ -145,8 +168,15 @@ jobs: echo "::endgroup::" - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: openttd-linux-generic path: build/bundles retention-days: 5 + + - name: Store symbols + uses: actions/upload-artifact@v4 + with: + name: symbols-linux-generic + path: build/symbols + retention-days: 5 diff --git a/.github/workflows/release-macos.yml b/.github/workflows/release-macos.yml index 9b0c82eb..6e673f2d 100644 --- a/.github/workflows/release-macos.yml +++ b/.github/workflows/release-macos.yml @@ -2,18 +2,23 @@ name: Release (MacOS) on: workflow_call: + inputs: + survey_key: + required: false + type: string + default: "" jobs: macos: name: MacOS - runs-on: macos-11 + runs-on: macos-latest env: MACOSX_DEPLOYMENT_TARGET: 10.13 steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source @@ -21,42 +26,34 @@ jobs: run: | tar -xf source.tar.gz --strip-components=1 + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + + - name: Enable Rust cache + uses: Swatinem/rust-cache@v2 + + - name: Setup vcpkg caching + uses: actions/github-script@v7 + with: + script: | + core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); + core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); + core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite') + - name: Install dependencies env: HOMEBREW_NO_AUTO_UPDATE: 1 HOMEBREW_NO_INSTALL_CLEANUP: 1 run: | + echo "::group::Install brew dependencies" brew install \ pandoc \ - pkg-config \ # EOF + echo "::endgroup::" - - name: Prepare cache key - id: key - run: | - echo "image=$ImageOS-$ImageVersion" >> $GITHUB_OUTPUT - - - name: Enable vcpkg cache - uses: actions/cache@v3 - with: - path: /usr/local/share/vcpkg/installed - key: ${{ steps.key.outputs.image }}-vcpkg-release-0 # Increase the number whenever dependencies are modified - restore-keys: | - ${{ steps.key.outputs.image }}-vcpkg-release - ${{ steps.key.outputs.image }}-vcpkg-x64 - - - name: Prepare vcpkg - run: | - vcpkg install \ - liblzma:x64-osx \ - liblzma:arm64-osx \ - libpng:x64-osx \ - libpng:arm64-osx \ - lzo:x64-osx \ - lzo:arm64-osx \ - zlib:x64-osx \ - zlib:arm64-osx \ - # EOF + echo "::group::Install breakpad dependencies" + cargo install dump_syms + echo "::endgroup::" - name: Install GCC problem matcher uses: ammaraskar/gcc-problem-matcher@master @@ -100,12 +97,13 @@ jobs: -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \ -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \ # EOF echo "::endgroup::" echo "::group::Build" echo "Running on $(sysctl -n hw.logicalcpu) cores" - cmake --build . -j $(sysctl -n hw.logicalcpu) + cmake --build . -j $(sysctl -n hw.logicalcpu) --target openttd echo "::endgroup::" - name: Build x64 @@ -120,6 +118,7 @@ jobs: -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \ -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \ -DCPACK_BUNDLE_APPLE_CERT_APP=${{ secrets.APPLE_DEVELOPER_CERTIFICATE_ID }} \ "-DCPACK_BUNDLE_APPLE_CODESIGN_PARAMETER=--deep -f --options runtime" \ -DAPPLE_UNIVERSAL_PACKAGE=1 \ @@ -128,9 +127,21 @@ jobs: echo "::group::Build" echo "Running on $(sysctl -n hw.logicalcpu) cores" - cmake --build . -j $(sysctl -n hw.logicalcpu) + cmake --build . -j $(sysctl -n hw.logicalcpu) --target openttd echo "::endgroup::" + - name: Create breakpad symbols + run: | + cd build-x64 + mkdir dSYM + dsymutil ./openttd -o dSYM/openttd + dump_syms ./dSYM/openttd --inlines --store symbols + + cd ../build-arm64 + mkdir dSYM + dsymutil ./openttd -o dSYM/openttd + dump_syms ./dSYM/openttd --inlines --store ../build-x64/symbols + - name: Create bundles run: | cd build-x64 @@ -191,8 +202,15 @@ jobs: mv _CPack_Packages/*/Bundle/openttd-*.zip bundles/ - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: openttd-macos-universal path: build-x64/bundles retention-days: 5 + + - name: Store symbols + uses: actions/upload-artifact@v4 + with: + name: symbols-macos-universal + path: build-x64/symbols + retention-days: 5 diff --git a/.github/workflows/release-source.yml b/.github/workflows/release-source.yml index 2213efed..331ba682 100644 --- a/.github/workflows/release-source.yml +++ b/.github/workflows/release-source.yml @@ -11,6 +11,8 @@ on: value: ${{ jobs.source.outputs.trigger_type }} folder: value: ${{ jobs.source.outputs.folder }} + survey_key: + value: ${{ jobs.source.outputs.survey_key }} jobs: source: @@ -23,18 +25,19 @@ jobs: is_tag: ${{ steps.metadata.outputs.is_tag }} trigger_type: ${{ steps.metadata.outputs.trigger_type }} folder: ${{ steps.metadata.outputs.folder }} + survey_key: ${{ steps.survey_key.outputs.survey_key }} steps: - name: Checkout (Release) if: github.event_name == 'release' - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: # We generate a changelog; for this we need the full git log. fetch-depth: 0 - name: Checkout (Manual) if: github.event_name == 'workflow_dispatch' - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: ref: ${{ github.event.inputs.ref }} # We generate a changelog; for this we need the full git log. @@ -42,7 +45,7 @@ jobs: - name: Checkout (Trigger) if: github.event_name == 'repository_dispatch' - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: ref: ${{ github.event.client_payload.ref }} # We generate a changelog; for this we need the full git log. @@ -146,6 +149,24 @@ jobs: FOLDER_NIGHTLIES: openttd-nightlies FOLDER_BRANCHES: openttd-branches + - name: Generate survey key + id: survey_key + run: | + if [ -z "${{ vars.SURVEY_TYPE }}" ]; then + echo "SURVEY_TYPE variable not found; most likely running in a fork. Skipping step." + SURVEY_KEY="" + else + PAYLOAD='{"version":"${{ steps.metadata.outputs.version }}","type":"${{ vars.SURVEY_TYPE }}"}' + + echo "${{ secrets.SURVEY_SIGNING_KEY }}" > survey_signing_key.pem + SIGNATURE=$(echo -n "${PAYLOAD}" | openssl dgst -sha256 -sign survey_signing_key.pem | base64 -w0) + rm -f survey_signing_key.pem + + SURVEY_KEY=$(curl -f -s -X POST -d "${PAYLOAD}" -H "Content-Type: application/json" -H "X-Signature: ${SIGNATURE}" https://survey-participate.openttd.org/create-survey-key/${{ vars.SURVEY_TYPE }}) + fi + + echo "survey_key=${SURVEY_KEY}" >> $GITHUB_OUTPUT + - name: Remove VCS information run: | rm -rf .git @@ -172,14 +193,14 @@ jobs: echo "::endgroup::" - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: openttd-source path: build/bundles/* retention-days: 5 - name: Store source (for other jobs) - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: internal-source path: source.tar.gz diff --git a/.github/workflows/release-windows-store.yml b/.github/workflows/release-windows-store.yml index 97b4398b..93aaafd7 100644 --- a/.github/workflows/release-windows-store.yml +++ b/.github/workflows/release-windows-store.yml @@ -15,7 +15,7 @@ jobs: steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source @@ -25,17 +25,17 @@ jobs: tar -xf source.tar.gz --strip-components=1 - name: Download x86 build - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-x86 - name: Download x64 build - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-x64 - name: Download arm64 build - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-arm64 @@ -185,7 +185,7 @@ jobs: move output\OpenTTD.appxbundle bundles\internal\openttd-${{ inputs.version }}-windows-store.appxbundle - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: openttd-windows-store path: builds/bundles diff --git a/.github/workflows/release-windows.yml b/.github/workflows/release-windows.yml index af67ffb1..5b5f6cd1 100644 --- a/.github/workflows/release-windows.yml +++ b/.github/workflows/release-windows.yml @@ -3,14 +3,16 @@ name: Release (Windows) on: workflow_call: inputs: + survey_key: + required: false + type: string + default: "" is_tag: required: true type: string jobs: windows: - name: Windows - strategy: fail-fast: false matrix: @@ -22,11 +24,13 @@ jobs: - arch: arm64 host: x64_arm64 + name: Windows (${{ matrix.arch }}) + runs-on: windows-latest steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source @@ -35,37 +39,30 @@ jobs: run: | tar -xf source.tar.gz --strip-components=1 - - name: Install dependencies - shell: bash - run: | - choco install pandoc - - - name: Prepare cache key - id: key - shell: powershell - run: | - # Work around caching failure with GNU tar - New-Item -Type Junction -Path vcpkg -Target c:\vcpkg + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable - Write-Output "image=$env:ImageOS-$env:ImageVersion" >> $env:GITHUB_OUTPUT + - name: Enable Rust cache + uses: Swatinem/rust-cache@v2 - - name: Enable vcpkg cache - uses: actions/cache@v3 + - name: Setup vcpkg caching + uses: actions/github-script@v7 with: - path: vcpkg/installed - key: ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }}-0 # Increase the number whenever dependencies are modified - restore-keys: | - ${{ steps.key.outputs.image }}-vcpkg-${{ matrix.arch }} + script: | + core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); + core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); + core.exportVariable('VCPKG_BINARY_SOURCES', 'clear;x-gha,readwrite') - - name: Prepare vcpkg + - name: Install dependencies shell: bash run: | - vcpkg install --triplet=${{ matrix.arch }}-windows-static \ - liblzma \ - libpng \ - lzo \ - zlib \ - # EOF + echo "::group::Install choco dependencies" + choco install pandoc + echo "::endgroup::" + + echo "::group::Install breakpad dependencies" + cargo install dump_syms + echo "::endgroup::" - name: Install MSVC problem matcher uses: ammaraskar/msvc-problem-matcher@master @@ -128,12 +125,13 @@ jobs: -DOPTION_USE_NSIS=ON \ -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \ -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \ # EOF echo "::endgroup::" echo "::group::Build" - cmake --build . + cmake --build . --target openttd echo "::endgroup::" env: WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }} @@ -152,16 +150,23 @@ jobs: -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \ -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \ -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \ # EOF echo "::endgroup::" echo "::group::Build" - cmake --build . + cmake --build . --target openttd echo "::endgroup::" env: WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }} + - name: Create breakpad symbols + shell: bash + run: | + cd build + dump_syms openttd.pdb --inlines --store symbols + - name: Create bundles shell: bash run: | @@ -170,10 +175,13 @@ jobs: cpack echo "::endgroup::" - echo "::group::Prepare PDB to be bundled" - PDB=$(ls bundles/*.zip | cut -d/ -f2 | sed 's/.zip$/.pdb/') - cp openttd.pdb bundles/${PDB} - xz -9 bundles/${PDB} + echo "::group::Move PDB and exe to symbols" + PDB_FOLDER=$(find symbols -mindepth 2 -type d) + cp openttd.pdb ${PDB_FOLDER}/ + + EXE_FOLDER=symbols/openttd.exe/$(grep "INFO CODE_ID" symbols/*/*/openttd.sym | cut -d\ -f3) + mkdir -p ${EXE_FOLDER} + cp openttd.exe ${EXE_FOLDER}/ echo "::endgroup::" echo "::group::Cleanup" @@ -194,8 +202,15 @@ jobs: WINDOWS_CERTIFICATE_COMMON_NAME: ${{ secrets.WINDOWS_CERTIFICATE_COMMON_NAME }} - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: openttd-windows-${{ matrix.arch }} path: build/bundles retention-days: 5 + + - name: Store symbols + uses: actions/upload-artifact@v4 + with: + name: symbols-windows-${{ matrix.arch }} + path: build/symbols + retention-days: 5 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a28a859f..ffbad50d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -38,6 +38,9 @@ jobs: uses: ./.github/workflows/release-linux.yml secrets: inherit + with: + survey_key: ${{ needs.source.outputs.survey_key }} + macos: name: MacOS needs: source @@ -45,6 +48,9 @@ jobs: uses: ./.github/workflows/release-macos.yml secrets: inherit + with: + survey_key: ${{ needs.source.outputs.survey_key }} + windows: name: Windows needs: source @@ -54,6 +60,7 @@ jobs: with: is_tag: ${{ needs.source.outputs.is_tag }} + survey_key: ${{ needs.source.outputs.survey_key }} windows-store: name: Windows Store @@ -69,8 +76,8 @@ jobs: with: version: ${{ needs.source.outputs.version }} - upload-cdn: - name: Upload (CDN) + upload: + name: Upload needs: - source - docs @@ -83,6 +90,25 @@ jobs: # The always() makes sure the rest is always evaluated. if: always() && needs.source.result == 'success' && needs.docs.result == 'success' && needs.linux.result == 'success' && needs.macos.result == 'success' && needs.windows.result == 'success' && (needs.windows-store.result == 'success' || needs.windows-store.result == 'skipped') + runs-on: ubuntu-latest + + # This job is empty, but ensures no upload job starts before all targets finished and are successful. + steps: + - name: Build completed + run: | + true + + upload-cdn: + name: Upload (CDN) + needs: + - source + - upload + + # As windows-store is condition, we need to check ourselves if we need to run. + # The always() makes sure the rest is always evaluated. + # Yes, you even need to do this if you yourself don't depend on the condition. + if: always() && needs.source.result == 'success' && needs.upload.result == 'success' + uses: ./.github/workflows/upload-cdn.yml secrets: inherit @@ -95,11 +121,13 @@ jobs: name: Upload (Steam) needs: - source - - linux - - macos - - windows + - upload - if: needs.source.outputs.trigger_type == 'new-master' || needs.source.outputs.trigger_type == 'new-tag' + # As windows-store is condition, we need to check ourselves if we need to run. + # The always() makes sure the rest is always evaluated. + # Yes, you even need to do this if you yourself don't depend on the condition. + # Additionally, only nightlies and releases go to Steam; not PRs. + if: always() && needs.source.result == 'success' && needs.upload.result == 'success' && (needs.source.outputs.trigger_type == 'new-master' || needs.source.outputs.trigger_type == 'new-tag') uses: ./.github/workflows/upload-steam.yml secrets: inherit @@ -112,11 +140,13 @@ jobs: name: Upload (GOG) needs: - source - - linux - - macos - - windows + - upload - if: needs.source.outputs.trigger_type == 'new-tag' + # As windows-store is condition, we need to check ourselves if we need to run. + # The always() makes sure the rest is always evaluated. + # Yes, you even need to do this if you yourself don't depend on the condition. + # Additionally, only releases go to GOG; not nightlies or PRs. + if: always() && needs.source.result == 'success' && needs.upload.result == 'success' && needs.source.outputs.trigger_type == 'new-tag' uses: ./.github/workflows/upload-gog.yml secrets: inherit diff --git a/.github/workflows/script-missing-mode-enforcement.yml b/.github/workflows/script-missing-mode-enforcement.yml new file mode 100644 index 00000000..5b985766 --- /dev/null +++ b/.github/workflows/script-missing-mode-enforcement.yml @@ -0,0 +1,22 @@ +name: Script missing mode enforcement + +on: + pull_request: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + +jobs: + script-missing-mode-enforcement: + name: Script missing mode enforcement + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Check for finding script functions that require company/deity mode enforcement/checks + run: | + set -ex + python3 .github/script-missing-mode-enforcement.py diff --git a/.github/workflows/unused-strings.yml b/.github/workflows/unused-strings.yml index 60266713..dc488b84 100644 --- a/.github/workflows/unused-strings.yml +++ b/.github/workflows/unused-strings.yml @@ -3,6 +3,10 @@ name: Unused strings on: pull_request: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} + jobs: unused-strings: name: Unused strings @@ -10,7 +14,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Check for unused strings run: | diff --git a/.github/workflows/upload-cdn.yml b/.github/workflows/upload-cdn.yml index f7f92522..91c5a165 100644 --- a/.github/workflows/upload-cdn.yml +++ b/.github/workflows/upload-cdn.yml @@ -21,7 +21,7 @@ jobs: steps: - name: Download all bundles - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 - name: Calculate checksums run: | @@ -54,19 +54,41 @@ jobs: done fi + - name: Merge symbols + run: | + mkdir symbols + cp -R symbols-*/* symbols/ + + # Compress all files as gzip, to reduce cost of storage on the CDN. + for i in $(find symbols -mindepth 2 -type f); do + gzip ${i} + done + + # Leave a mark in each folder what version actually created the symbol file. + for i in $(find symbols -mindepth 2 -type d); do + touch ${i}/.${{ inputs.version }}.txt + done + - name: Store bundles - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: cdn-bundles path: bundles/* retention-days: 5 - publish: + - name: Store breakpad symbols + uses: actions/upload-artifact@v4 + with: + name: cdn-symbols + path: symbols/* + retention-days: 5 + + publish-bundles: needs: - prepare - name: Publish - uses: OpenTTD/actions/.github/workflows/rw-cdn-upload.yml@v4 + name: Publish bundles + uses: OpenTTD/actions/.github/workflows/rw-cdn-upload.yml@v5 secrets: CDN_SIGNING_KEY: ${{ secrets.CDN_SIGNING_KEY }} DEPLOYMENT_APP_ID: ${{ secrets.DEPLOYMENT_APP_ID }} @@ -76,10 +98,22 @@ jobs: folder: ${{ inputs.folder }} version: ${{ inputs.version }} + publish-symbols: + needs: + - prepare + + name: Publish symbols + uses: OpenTTD/actions/.github/workflows/rw-symbols-upload.yml@v5 + secrets: + SYMBOLS_SIGNING_KEY: ${{ secrets.SYMBOLS_SIGNING_KEY }} + with: + artifact-name: cdn-symbols + repository: OpenTTD + docs: if: ${{ inputs.trigger_type == 'new-master' }} needs: - - publish + - publish-bundles name: Publish docs @@ -88,14 +122,15 @@ jobs: steps: - name: Generate access token id: generate_token - uses: tibdex/github-app-token@v1 + uses: tibdex/github-app-token@v2 with: app_id: ${{ secrets.DEPLOYMENT_APP_ID }} private_key: ${{ secrets.DEPLOYMENT_APP_PRIVATE_KEY }} - repository: OpenTTD/workflows + installation_retrieval_mode: "repository" + installation_retrieval_payload: "OpenTTD/workflows" - name: Trigger 'Publish Docs' - uses: peter-evans/repository-dispatch@v2 + uses: peter-evans/repository-dispatch@v3 with: token: ${{ steps.generate_token.outputs.token }} repository: OpenTTD/workflows diff --git a/.github/workflows/upload-gog.yml b/.github/workflows/upload-gog.yml index c1d06788..1370988f 100644 --- a/.github/workflows/upload-gog.yml +++ b/.github/workflows/upload-gog.yml @@ -15,31 +15,31 @@ jobs: steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source path: internal-source - name: Download bundle (Windows x86) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-x86 path: openttd-windows-x86 - name: Download bundle (Windows x64) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-x64 path: openttd-windows-x64 - name: Download bundle (MacOS) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-macos-universal path: openttd-macos-universal - name: Download bundle (Linux) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-linux-generic path: openttd-linux-generic diff --git a/.github/workflows/upload-steam.yml b/.github/workflows/upload-steam.yml index 808983f8..47fa48d0 100644 --- a/.github/workflows/upload-steam.yml +++ b/.github/workflows/upload-steam.yml @@ -18,31 +18,31 @@ jobs: steps: - name: Download source - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: internal-source path: internal-source - name: Download bundle (Windows x86) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-x86 path: openttd-windows-x86 - name: Download bundle (Windows x64) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-windows-x64 path: openttd-windows-x64 - name: Download bundle (MacOS) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-macos-universal path: openttd-macos-universal - name: Download bundle (Linux) - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: openttd-linux-generic path: openttd-linux-generic diff --git a/.gitignore b/.gitignore index 4eed0f0e..3d0376aa 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ docs/aidocs/* docs/gamedocs/* docs/source/* /out +/vcpkg_installed diff --git a/.ottdrev b/.ottdrev index a3cf7a55..67319e8d 100644 --- a/.ottdrev +++ b/.ottdrev @@ -1 +1 @@ -13.4 20230730 0 7e457a367e67f4e1b7d28ebd769e3a649ea60175 1 1 2023 +14.0-beta1 20240203 0 22eed9616efebf65a19bdb25e2c4bd968f719665 1 0 2024 diff --git a/.release_date b/.release_date index 216bc29b..c348b990 100644 --- a/.release_date +++ b/.release_date @@ -1 +1 @@ -2023-07-29 23:01 UTC +2024-02-03 19:50 UTC diff --git a/.version b/.version index c5644b45..cac474ff 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -13.4 +14.0-beta1 diff --git a/CMakeLists.txt b/CMakeLists.txt index e4da7c2f..4527e5ab 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,11 +1,12 @@ -cmake_minimum_required(VERSION 3.9) +cmake_minimum_required(VERSION 3.16) if(NOT BINARY_NAME) set(BINARY_NAME openttd) endif() project(${BINARY_NAME} - VERSION 13.4 + VERSION 14.0 + LANGUAGES CXX ) if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR) @@ -22,7 +23,7 @@ if (EMSCRIPTEN) endif() set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake") -set(CMAKE_OSX_DEPLOYMENT_TARGET 10.13) +set(CMAKE_OSX_DEPLOYMENT_TARGET 10.15) # Use GNUInstallDirs to allow customisation # but set our own default data and bin dir @@ -41,7 +42,7 @@ set_directory_options() include(Static) set_static_if_needed() -set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD 20) set(CMAKE_CXX_STANDARD_REQUIRED YES) set(CMAKE_CXX_EXTENSIONS NO) @@ -125,6 +126,19 @@ find_package(LZO) find_package(ZSTD 1.4) find_package(PNG) +if(WIN32 OR EMSCRIPTEN) + # Windows uses WinHttp for HTTP requests. + # Emscripten uses Javascript for HTTP requests. +else() + # All other targets use libcurl. + find_package(CURL) +endif() + +# Breakpad doesn't support emscripten. +if(NOT EMSCRIPTEN) + find_package(unofficial-breakpad) +endif() + if(NOT OPTION_DEDICATED) if(NOT WIN32) find_package(Allegro) @@ -135,12 +149,17 @@ if(NOT OPTION_DEDICATED) find_package(SDL) endif() find_package(Fluidsynth) - find_package(Fontconfig) - find_package(ICU OPTIONAL_COMPONENTS i18n lx) + if(Freetype_FOUND) + find_package(Fontconfig) + endif() + find_package(Harfbuzz) + find_package(ICU OPTIONAL_COMPONENTS i18n) endif() endif() endif() if(APPLE) + enable_language(OBJCXX) + find_package(Iconv) find_library(AUDIOTOOLBOX_LIBRARY AudioToolbox) @@ -171,6 +190,12 @@ if(UNIX AND NOT APPLE AND NOT OPTION_DEDICATED) if(NOT SDL_FOUND AND NOT SDL2_FOUND AND NOT ALLEGRO_FOUND) message(FATAL_ERROR "SDL, SDL2 or Allegro is required for this platform") endif() + if(HARFBUZZ_FOUND AND NOT ICU_i18n_FOUND) + message(WARNING "HarfBuzz depends on ICU i18n to function; HarfBuzz will be disabled") + endif() + if(NOT HARFBUZZ_FOUND) + message(WARNING "Without HarfBuzz and ICU i18n the game will not be able to render right-to-left languages correctly") + endif() endif() if(APPLE) if(NOT AUDIOTOOLBOX_LIBRARY) @@ -208,6 +233,7 @@ if(OPTION_PACKAGE_DEPENDENCIES) set(CMAKE_BUILD_WITH_INSTALL_RPATH ON) endif() +include(CTest) include(SourceList) # Needed by rev.cpp @@ -217,15 +243,31 @@ include_directories(${CMAKE_SOURCE_DIR}/src/3rdparty/squirrel/include) include(MSVCFilters) -add_executable(openttd WIN32 ${GENERATED_SOURCE_FILES}) +add_library(openttd_lib OBJECT ${GENERATED_SOURCE_FILES}) +add_executable(openttd WIN32) +add_executable(openttd_test) set_target_properties(openttd PROPERTIES OUTPUT_NAME "${BINARY_NAME}") # All other files are added via target_sources() if(MSVC) # Add DPI manifest to project; other WIN32 targets get this via ottdres.rc target_sources(openttd PRIVATE "${CMAKE_SOURCE_DIR}/os/windows/openttd.manifest") + + # If target -static is used, switch our project to static (/MT) too. + # If the target ends on -static-md, it will remain dynamic (/MD). + if(VCPKG_TARGET_TRIPLET MATCHES "-static" AND NOT VCPKG_TARGET_TRIPLET MATCHES "-md") + set_property(TARGET openttd_lib PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$:Debug>") + set_property(TARGET openttd PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$:Debug>") + set_property(TARGET openttd_test PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$:Debug>") + endif() endif() +target_precompile_headers(openttd_lib + PRIVATE + src/stdafx.h + src/core/format.hpp +) + add_subdirectory(${CMAKE_SOURCE_DIR}/bin) add_subdirectory(${CMAKE_SOURCE_DIR}/src) add_subdirectory(${CMAKE_SOURCE_DIR}/media) @@ -233,17 +275,25 @@ add_subdirectory(${CMAKE_SOURCE_DIR}/media) add_dependencies(openttd find_version) -target_link_libraries(openttd +target_link_libraries(openttd_lib openttd::languages openttd::settings - openttd::media - openttd::basesets openttd::script_api Threads::Threads ) +target_link_libraries(openttd + openttd_lib + openttd::media + openttd::basesets +) + +target_link_libraries(openttd_test PRIVATE openttd_lib) +include(Catch) +catch_discover_tests(openttd_test) + if(HAIKU) - target_link_libraries(openttd "be" "network" "midi") + target_link_libraries(openttd_lib "be" "network" "midi") endif() if(IPO_FOUND) @@ -261,6 +311,15 @@ link_package(LIBLZMA TARGET LibLZMA::LibLZMA ENCOURAGED) link_package(LZO) link_package(ZSTD ENCOURAGED) +if(NOT WIN32 AND NOT EMSCRIPTEN) + link_package(CURL ENCOURAGED) + target_link_libraries(openttd_lib ${CMAKE_DL_LIBS}) +endif() + +if(NOT EMSCRIPTEN) + link_package(unofficial-breakpad TARGET unofficial::breakpad::libbreakpad_client ENCOURAGED) +endif() + if(NOT OPTION_DEDICATED) link_package(Fluidsynth) link_package(SDL) @@ -268,7 +327,7 @@ if(NOT OPTION_DEDICATED) link_package(Allegro) link_package(FREETYPE TARGET Freetype::Freetype) link_package(Fontconfig TARGET Fontconfig::Fontconfig) - link_package(ICU_lx) + link_package(Harfbuzz TARGET harfbuzz::harfbuzz) link_package(ICU_i18n) if(SDL2_FOUND AND OPENGL_FOUND AND UNIX) @@ -287,7 +346,7 @@ include(CheckAtomic) if(APPLE) link_package(Iconv TARGET Iconv::Iconv) - target_link_libraries(openttd + target_link_libraries(openttd_lib ${AUDIOTOOLBOX_LIBRARY} ${AUDIOUNIT_LIBRARY} ${COCOA_LIBRARY} @@ -306,6 +365,7 @@ if(EMSCRIPTEN) target_link_libraries(WASM::WASM INTERFACE "-s ALLOW_MEMORY_GROWTH=1") target_link_libraries(WASM::WASM INTERFACE "-s INITIAL_MEMORY=33554432") target_link_libraries(WASM::WASM INTERFACE "-s DISABLE_EXCEPTION_CATCHING=0") + target_link_libraries(WASM::WASM INTERFACE "-s WASM_BIGINT") add_definitions(-s DISABLE_EXCEPTION_CATCHING=0) # Export functions to Javascript. @@ -321,6 +381,23 @@ if(EMSCRIPTEN) target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_BINARY_DIR}/lang/english.lng@/lang/english.lng") target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/bin/ai@/ai") target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/bin/game@/game") + # Documentation files for the in-game text file viewer + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/README.md@/README.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/CREDITS.md@/CREDITS.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md@/CONTRIBUTING.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/COPYING.md@/COPYING.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/known-bugs.txt@/known-bugs.txt") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/changelog.txt@/changelog.txt") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/admin_network.md@/docs/admin_network.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/debugging_desyncs.md@/docs/debugging_desyncs.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/desync.md@/docs/desync.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/directory_structure.md@/docs/directory_structure.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/eints.md@/docs/eints.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/linkgraph.md@/docs/linkgraph.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/logging_and_performance_metrics.md@/docs/logging_and_performance_metrics.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/multiplayer.md@/docs/multiplayer.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/savegame_format.md@/docs/savegame_format.md") + target_link_libraries(WASM::WASM INTERFACE "--preload-file ${CMAKE_SOURCE_DIR}/docs/symbol_server.md@/docs/symbol_server.md") # We use IDBFS for persistent storage. target_link_libraries(WASM::WASM INTERFACE "-lidbfs.js") @@ -366,12 +443,14 @@ if(WIN32) -DPSAPI_VERSION=1 ) - target_link_libraries(openttd + target_link_libraries(openttd_lib ws2_32 winmm imm32 usp10 psapi + winhttp + bcrypt ) endif() @@ -379,8 +458,9 @@ if(CMAKE_SIZEOF_VOID_P EQUAL 8) add_definitions(-DPOINTER_IS_64BIT) endif() -include(CreateRegression) -create_regression() +enable_testing() + +add_subdirectory(regression) if(APPLE OR WIN32) find_package(Pandoc) diff --git a/CODINGSTYLE.md b/CODINGSTYLE.md new file mode 100644 index 00000000..b9baf7ba --- /dev/null +++ b/CODINGSTYLE.md @@ -0,0 +1,488 @@ +**Why a set coding style is important**
+This project is an open source project. To get open source working as intended, many people should be able to comprehend the code. This implies that there is a well documented and uniform flow of code. +That does not necessarily mean that a contributor should not write optimised yet cryptic code - one should always care about performance. However, other developers need to understand the code which means complicated parts of code **must** have good documentation. + +**Why we require that EVERYTHING is documented**
+What is simple to some might appear very complicated to others. Documentation helps these others. Anyone should be able to improve the code. But the main reason is, that when patch contributors want their patches added to the common codebase, the code needs to be reviewed by one or more developers. Documentation makes reviewing much easier. + +## Coding style for OpenTTD +### Functions +* Function names use [CamelCase](http://www.wikipedia.org/wiki/Camelcase) without underscores. +* Opening curly bracket **{** for a function starts on the next line. +* Use Foo() instead of Foo(void). +```c++ +void ThisIsAFunction() +{ +} +``` + +### Variables +* Variable names are all lowercase, and use "_" as separator. +* Global variables are preceded by an underscore. ("_") Use descriptive names because leading underscores are often used for system / compiler variables. +* Own members of classes should always be referenced using "this->" +* Pointers and references should have their reference symbol next to the name (compatibility with current code). +* Variables that are declared below one another should have their type, name or reference operator, and assignment operator aligned by spaces. +* There are set names for many variables. Those are (but not limited to): Vehicle *u, *v, *w; Station *st; Town *t; Window *w; Engine *e. +* For multiple instances, use numbers "*t1, *t2" or postfixes "*st_from, *st_to". +* Declare variables upon first usage. +* Declare iterators in their loop. +* There is a space between '*' and 'const' in "const pointers" +```c++ +int number = 10; +Vehicle *u_first_wagon = v->next; +int value = v->value; + +uint32 _global_variable = 3750; + +static const char * const _global_array[] = { + "first string", + "second string", + "another string", + "last string followed by comma", +}; + +protected: + char protected_array[10]; + +for (int i = 0;;); +``` + +* Give the variables expedient names, this increases the readability of the code +```c++ +bool is_maglev_train = true; +if (!is_maglev_train) DoSomething(); +``` + +* Some people like to introduce copies of variables to increase readability, which can waste memory. However, in some cases, especially in code pieces which are often called, it makes sense to cache some calculated variables. +```c++ +/* Unoptimized code: + * foo is not touched inside the loop! + */ +for (uint8 i = 0; i < 100000; i++) { + /* Do something */ + if (value_to_check == (foo * 4) % 5 + 6) DoSomething(); + /* Do something else */ +} + +/* Better: + * The used value of foo is calculated outside the loop. + */ +const uint32 bar = (foo * 4) % 5 + 6; +for (uint8 i = 0; i < 100000; i++) { + /* Do something */ + if (value_to_check == bar) DoSomething(); + /* Do something else */ +} +``` + +### Enumerations / static consts +* Enumerations store integers that belong logically together (railtypes, string IDs, etc.). +* Enumeration names also use CamelCase. +* Unscoped enumerators are all caps with "_" between the words. +* Scoped enumerators are use CamelCase. +* Enums are not used to store single numbers. +* Enums have consecutive numbers OR +* Enums have consecutive powers of two. Powers of two (bits) are written in hex or with the shift operator. +* Enums may have special enumerators: "_BEGIN", "\_END", and "INVALID\_"). See example. +* The invalid always has 0xFF, 0xFFFF, 0xFFFFFFFF as a value. +* Other special values are consecutively less than the invalid. +* Variables that hold enumerators should have the type of the enumeration. +```c++ +enum DiagDirection { + DIAGDIR_BEGIN = 0, + DIAGDIR_NE = 0, + DIAGDIR_SE = 1, + DIAGDIR_SW = 2, + DIAGDIR_NW = 3, + DIAGDIR_END, + INVALID_DIAGDIR = 0xFF, + BROKEN_DIAGDIR = 0xFE, +}; + +enum { + DEPOT_SERVICE = (1 << 0), + DEPOT_MASS_SEND = (1 << 1), + DEPOT_DONT_CANCEL = (1 << 2), + DEPOT_LOCATE_HANGAR = (1 << 3), +}; + +DiagDirection enterdir = DIAGDIR_NE; +``` + +* Numbers that store single or uncorrelated data are static consts. Those may use the naming conventions of enums. +Example: +```c++ +static const int MAXIMUM_STATIONS = 42; +``` + +* Enums are useful in GUI code: When widgets are enumerated, they are easier to access during many operations. Additionally changes caused by modified widget sequences require less code adapting. If a widget is used like this, its enum name should be present in a comment behind the corresponding widget definition. +```c++ +/** Enum referring to the widgets of the build rail depot window */ +enum BuildRailDepotWidgets { + BRDW_CLOSEBOX = 0, + BRDW_CAPTION, + BRDW_BACKGROUND, + BRDW_DEPOT_NE, + BRDW_DEPOT_SE, + BRDW_DEPOT_SW, + BRDW_DEPOT_NW, +}; +/* ... */ +/** Widget definition of the build rail depot window */ +static const Widget _build_depot_widgets[] = { +{ WWT_CLOSEBOX, RESIZE_NONE, 7, 0, 10, 0, 13, STR_00C5, STR_..}, // BRDW_CLOSEBOX +{ WWT_CAPTION, RESIZE_NONE, 7, 11, 139, 0, 13, STR_..., STR_...}, // BRDW_CAPTION +{ WWT_PANEL, RESIZE_NONE, 7, 0, 139, 14, 121, 0x0, STR_NULL}, // BRDW_BACKGROUND +{ WWT_PANEL, RESIZE_NONE, 14, 71, 136, 17, 66, 0x0, STR_..}, // BRDW_DEPOT_NE +{ WWT_PANEL, RESIZE_NONE, 14, 71, 136, 69, 118, 0x0, STR_..}, // BRDW_DEPOT_SE +{ WWT_PANEL, RESIZE_NONE, 14, 3, 68, 69, 118, 0x0, STR_..}, // BRDW_DEPOT_SW +{ WWT_PANEL, RESIZE_NONE, 14, 3, 68, 17, 66, 0x0, STR_..}, // BRDW_DEPOT_NW +{ WIDGETS_END}, +}; +``` + +* Comments on the enum values should start with "///<" to enable doxygen documentation +```c++ +enum SomeEnumeration { + SE_BEGIN = 0, ///< Begin of the enumeration, used for iterations + SE_FOO = 0, ///< Used for xy + SE_BAR, ///< Another value of the enumeration + SE_SUB, ///< Special case for z + SE_END, ///< End of the enumeration, used for iterations +}; +``` + +### Control flow +* Put a space before the parentheses in **if**, **switch**, **for** and **while** statements. +* Use curly braces and put the contained statements on their own lines (e.g., don't put them directly after the **if**). +* Opening curly bracket **{** stays on the first line, closing curly bracket **}** gets a line to itself (except for the **}** preceding an **else**, which should be on the same line as the **else**). +* When only a single statement is contained, the brackets can be omitted. In this case, put the single statement on the same line as the preceding keyword (**if**, **while**, etc.). Note that this is only allowed for if statements without an **else** clause. +* All fall throughs must be documented, using a **FALLTHROUGH** define/macro. +* The NOT_REACHED() macro can be used in default constructs that should never be reached. +* Unconditional loops are written with **`for (;;) {`** + +```c++ +if (a == b) { + Foo(); +} else { + Bar(); +} + +if (very_large_checks && + spread_over_two_lines) { + Foo(); +} + +if (a == b) Foo(); + +switch (a) { + case 0: DoSomethingShort(); break; + + case 1: + DoSomething(); + FALLTHROUGH; + + case 2: + DoMore(); + b = a; + break; + + case 3: { + int r = 2; + + DoEvenMore(a); + FALLTHROUGH; + } + + case 4: { + int q = 345; + + DoIt(); + break; + } + + default: + NOT_REACHED(); +} + +for (int i = 0; i < 10; i++) { + Foo(); + Bar(); +} +``` + +### Classes +* Classes names also use CamelCase. +* Classes should have "public", "protected", and "private" sections. +* Within these section the order is: types, static const members, static members, members, constructors / destructors, static methods, methods. +* Deviations from above order are allowed when the code dictates it (e.g. a static const is needed for a typedef) +* Methods and members ought to be grouped logically. +* All those sorting rules sometimes conflict which one another. Please use common sense what increases legibility of the code in such a case. +* The method implementation should indicate if it is virtual or similar by using a comment. +* Very short methods can have one-line definition (if defined in the class scope). +```c++ +class ThisIsAClass { +public: + typedef Titem_ *ItemPtr; +private: + static const int MAX_SIZE = 500; + int size; + ItemPtr *items; + +public: + explicit ThisIsAClass(); + ~ThisIsAClass(); + + int GetSize() { return this->size; } + virtual void Method(); +}; + +/*virtual*/ void Class::Method() +{ + this->size *= 2; +} +``` + +### Templates +Templates are a very powerful C++ tool, but they can easily confuse beginners. Thus: +* Templates are to be documented in a very clear and verbose manner. Never assume anything in the documentation. +* the template keyword and the template layout get a separate line. typenames are either "T" or preceded by a "T", integers get a single capital letter or a descriptive name preceded by "T". +```c++ +template +int Func(); +``` + +* If you are writing one or more template class in the dedicated header file, use file.hpp for its name instead of file.h. This will let others know that it is template library (includes also implementation), not just header with declarations. + +### Other important rules +* Put a space before and after binary operators: "a + b", "a == b", "a & b", "a <<= b", etc.. Exceptions are ".", "->" and "[]" (no spaces) and "," (just space after it). +* Put parenthesis where it improves readability: "*(b++)" instead of "*b++", and "if ((a & b) && c == 2)" instead of "if (a & b && c == 2)". +* Do not put external declarations in implementation (i.e. cpp) files. +* Use const where possible. +* Do not typedef enums and structs. +* Don't treat non-flags as flags: use "if (char_pointer != nullptr && *char_pointer != '\0')", not "if (char_pointer && *char_pointer)". +* Use "free(p)" instead of "if (p != nullptr) free(p)". "free(nullptr)" doesn't hurt anyone. +* No trailing whitespace. The Github workflows will not allow tabs or space on the end of lines. +* Only use tabs to indent from the start of the line. +* Line length is unlimited. In practice it may be useful to split a long line. When splitting, add two tabs in front of the second part. +* The '#' of preprocessor instructions goes into the first column of a line. Indenting is done after the '#' (using tabs again). +* Use /* */ for single line comments. +* Use // at the end of a command line to indicate comments. +** However, use /* */ after # preprocessor statements as // causes warnings in some compilers and/or might have unwanted side effects. +* C++ is defined using the ASCII character set. Do not use other character sets, not even in comments. +* OpenTTD includes some Objective-C sources (*.mm, used by OSX), which has a special object method invocation syntax: "[ obj doStuff:foo ]". Please use spaces on the inside of the brackets to differentiate from the C array syntax. + +## Documentation +We use [Doxygen](http://doxygen.org/) to automatically generate documentation from the source code. It scans the source files for *recognizable* comments. +* **Make your comments recognizable.** +Doxygen only comments starting with the following style: +```c++ +/** +///< +``` + +Use /** for multi-line comment blocks. Use ///< for single line comments for variables. Use //!< for single-line comments in the NoAI .hpp files. +For comments blocks inside a function always use /* */ or //. Use // only if the comment is on the same line as an instruction, otherwise use /* */. + +### Files +* Put a @file command in a JavaDoc style comment at the start of the file, followed by a description. +```c++ +/** + * @file + * This is the brief description. + * This is the detailed description here and on the following lines. + */ +``` +> ### Warning +> If a file lacks a **file comment block** then NO entities in that file will be documented by Doxygen! + +### Functions +* The documentation should be as close to the actual code as possible to maximise the chance of staying in sync. + * Comments for functions go in the .cpp file. + * Comments for inlines go in the .h/.hpp file. +* Small inlines can have a short 3 or 4 line JavaDoc style comment. +* Completely document larger functions. +* Document obvious parameters and return values too! + +```c++ +/** + * A brief explanation of what the function does and/or what purpose it serves. + * Then follows a more detailed explanation of the function that can span multiple lines. + * + * @param foo Explanation of the foo parameter + * @param bar Explanation of the bar parameter + * @return The sum of foo and bar (@return can be omitted if the return type is void) + * + * @see SomeOtherFunc() + * @see SOME_ENUM + * + * @bug Some bug description + * @bug Another bug description which continues in the next line + * and ends with the following blank line + * + * @todo Some to-do entry + */ +static int FooBar(int foo, int bar) +{ + return foo + bar; +} +``` + +### Classes +* Document structs similarly to functions: +```c++ +/** + * A short description of the struct. + * More detailed description of the its usage. + * + * @see [link to anything of interest] + */ +struct foo { +} +``` + +### JavaDoc structural commands + +This table shows the commands you should use with OpenTTD. The full list is [here](http://www.stack.nl/~dimitri/doxygen/commands.html). + +| Command | Action | Example | +| ------- | -------- | ------- | +| **@attention** | Starts a paragraph where a message that needs attention may be entered. The paragraph will be indented. | @attention Whales crossing! | +| **@brief** | Starts a paragraph that serves as a brief description. For classes and files the brief description will be used in lists and at the start of the documentation page. For class and file members, the brief description will be placed at the declaration of the member and prepended to the detailed description. A brief description may span several lines (although it is advised to keep it brief!). | @brief This is the brief description. | +| **@bug** | Starts a paragraph where one or more bugs may be reported. The paragraph will be indented. Multiple adjacent @bug commands will be joined into a single paragraph. Each bug description will start on a new line. Alternatively, one @bug command may mention several bugs. | @bug Memory leak in here? | +| **@note** | Starts a paragraph where a note can be entered. The paragraph will be indented. | @note Might be slow | +| **@todo** | Starts a paragraph where a TODO item is described. The description will also add an item to a separate TODO list. The two instances of the description will be cross-referenced. Each item in the TODO list will be preceded by a header that indicates the origin of the item. | @todo Better error checking | +| **@warning** | Starts a paragraph where one or more warning messages may be entered. The paragraph will be indented. | @warning Not thread safe! | +| | **Function related commands** | | +| **@return** | Starts a return value description for a function. | @return a character pointer | +| **@param** | Starts a parameter description for a function parameter with name . Followed by a description of the parameter. The existence of the parameter is checked and a warning is given if the documentation of this (or any other) parameter is missing or not present in the function declaration or definition.

The @param command has an optional attribute specifying the direction of the attribute. Possible values are "in" and "out". | @param n The number of bytes to copy
@param[out] dest The memory area to copy to.
@param[in] src The memory area to copy from. | +| **@see** | Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. Two names joined by either :: or # are understood as referring to a class and one of its members. One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after the method name. [Here](http://www.stack.nl/~dimitri/doxygen/autolink.html) you can find detailed information about this feature. | @see OtherFunc() | +| **@b** | Displays the following word using a bold font. Equivalent to <b>word</b>. To put multiple words in bold use <b>multiple words</b>.| ...@b this and @b that... | +| **@c / @p** | Displays the parameter using a typewriter font. You can use this command to refer to member function parameters in the running text. To have multiple words in typewriter font use <tt>multiple words</tt>. | ... the @p x and @p y coordinates are used to... | +| **@arg / @li** | This command has one argument that continues until the first blank line or until another @arg / @li is encountered. The command can be used to generate a simple, not nested list of arguments. Each argument should start with an @arg / @li command. | @arg @c AlignLeft left alignment.
@arg @c AlignCenter center alignment.
@arg @c AlignRight right alignment | +| **@n** | Forces a new line. Equivalent to and inspired by the printf function. |@n | + +### More on Doxygen and JavaDoc + +Doxygen knows two different kinds of comments: +* *Brief descriptions*: one-liners that describe the function roughly ([example](http://docs.openttd.org/annotated.html)) +* *Detailed descriptions*: as the name suggests, these contain the detailed function/purpose of the entity they describe ([example](http://docs.openttd.org/structBridge.html)) + +You can omit either one or put them into different places but there's only one brief and one detailed description allowed for the same entity. + +Doxygen knows three modes for documenting an entity: +* Before the entity +* After the entity +* In a different file + +The latter is a little harder to maintain since the prototype of the entity it describes then is stored in several places (e.g. the .h file and the file with the descriptions). Also while it makes the code easier to read it also makes it easier to omit the important step of updating the description of an entity if it was changed - and we all know why that shouldn't happen ;)
+Because of those reasons, we will only use the first two documentation schemes. + + +Doxygen supports both Qt and JavaDoc comment styles: +* Qt style example: **int i; //!< The counter for the main loop** +* JavaDoc style example: **int i; /*\*< The counter for the main loop \*/** + +It also supports more comment styles but those two are the ones which are standardized. For OTTD we'll be using the JavaDoc style. One of the reasons is that it has a feature that the Qt style doesn't offer: JavaDoc style comment blocks will automatically start a brief description which ends at the first dot followed by a space or new line. Everything after that will also be part of the detailed description. + +The general structure of a JavaDoc style comment is +```c++ +/** + * This is the brief description. And this sentence contains some further explanations that will appear in the detailed description only. + */ +``` + +and the resulting descriptions of that block would be: +* *Brief description*: This is the brief description. +* *Detailed description*: This is the brief description. And this sentence contains some further explanations that will appear in the detailed description only. + +The distinction between the brief and detailed descriptions is made by the dot followed by a space/newline, so if you want to use that inside the brief description you need to escape the space/newline: +```c++ +/** + * This is a brief description (e.g.\ using only a few words). Details go here. + */ +``` + +If you're doing a one-line comment, use: +```c++ +int i; ///< This is the description. +``` + +Also in the comment block you can include so-called structural commands which tell Doxygen what follows. In general, their area of effect begins after the command word and ends when a blank line or some other command is encountered. Also, multiple occurrences of the same structural command within a comment block or the referring entity will be joined in the documentation output usually. + +## Commit message +To achieve a coherent whole and to make changelog writing easier, here are some guidelines for commit messages. +There is a check-script on the git server (also available for clients, see below) to make sure we all follow those rules. + +The first line of a message must match: +``` +( #| (, ( #|))*)?: ([ +``` +Keywords are: +* Add, Feature: Adding new stuff. Difference between "Feature" and "Add" is somewhat subjective. "Feature" for user-point-of-view stuff, "Add" for other. +* Change: Changing behaviour from user-point-of-view. +* Remove: Removing something from user-point-of-view. +* Codechange, Cleanup: Changes without intentional change of behaviour from user-point-of-view. Difference between "Codechange" and "Cleanup" is somewhat subjective. +* Fix, Revert: Fixing stuff. +* Doc, Update: Documentation changes, version increments, translator commits. +* Prepare: Preparation for bigger changes. Rarely used. + +If you commit a fix for an [issue](https://github.com/OpenTTD/OpenTTD/issues), add the corresponding issue number in the form of #NNNN. Do it as well if you implement a feature with a matching entry. + +In the case of bugfixes, if you know what revision the bug was introduced (eg regression), please mention that revision as well just after the prefix. Finding the trouble-causing revision is highly encouraged as it makes backporting/branching/releases that much easier. + +To further structure the changelog, you can add sections. Example are: +* "Network" for network specific changes +* "NewGRF" for NewGRF additions +* "YAPP", "NPF", for changes in these features +* "OSX", "Debian", "win32", for OS-specific packaging changes + +Further explanations, general bitching, etc. don't go into the first line. Use a new line for those. + +Complete examples: +* Fix: [YAPF] Infinite loop in pathfinder. +* Fix #5926: [YAPF] Infinite loop in pathfinder. +* Fix 80dffae130: Warning about unsigned unary minus. +* Fix #6673, 99bb3a95b4: Store the map variety setting in the samegame. +* Revert d9065fbfbe, Fix #5922: ClientSizeChanged is only called via WndProcGdi which already has the mutex. +* Fix #1264, Fix #2037, Fix #2038, Fix #2110: Rewrite the autoreplace kernel. + + +## Other tips +### Remove trailing whitespace +To find out if/where you have trailing whitespace, you can use the following (unix/bash) command: +``` +grep -n -R --include "*.[ch]" '[ ]$' * | grep --invert-match ".diff" | grep --invert-match ".patch" +``` +Automatically removing whitespace is also possible with the following shell script (Note that it only checks .c, .cpp, .h, .hpp and .mm files): +``` +#!/bin/sh +IFS=' +' +for i in Makefile `find . -name \*.c -o -name \*.cpp -o -name \*.h -o -name \*.hpp -o -name \*.mm` +do + ( + echo '%s/[ ]\{1,\}$/' + echo w + echo q + ) | ed $i 2> /dev/null > /dev/null +done +``` + +### Install the client-side git commit hooks + +The client-side hooks perform various checks when you commit changes locally. +* Whitespace and indentation checks. +* **Coding style** checks. + +Get the hooks: +``` +git clone https://github.com/OpenTTD/OpenTTD-git-hooks.git openttd_hooks +``` + +Install the hooks, assuming "openttd" is your work tree folder: +``` +cd openttd/.git/hooks +ln -s -t . ../../../openttd_hooks/hooks/* +``` + diff --git a/COMPILING.md b/COMPILING.md index ba910ed6..578b5e45 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -4,20 +4,25 @@ OpenTTD makes use of the following external libraries: +- (encouraged) breakpad: creates minidumps on crash - (encouraged) zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads, heightmaps - (encouraged) liblzma: (de)compressing of savegames (1.1.0 and later) - (encouraged) libpng: making screenshots and loading heightmaps - (optional) liblzo2: (de)compressing of old (pre 0.3.0) savegames -For Linux, the following additional libraries are used (for non-dedicated only): +For Linux, the following additional libraries are used: +- (encouraged) libcurl: content downloads - libSDL2: hardware access (video, sound, mouse) - libfreetype: loading generic fonts and rendering them - libfontconfig: searching for fonts, resolving font names to actual fonts +- harfbuzz: handling of right-to-left scripts (e.g. Arabic and Persian) (required libicu) - libicu: handling of right-to-left scripts (e.g. Arabic and Persian) and natural sorting of strings +If you are building a dedicated-server only, you don't need the last four. + OpenTTD does not require any of the libraries to be present, but without liblzma you cannot open most recent savegames and without zlib you cannot open most older savegames or use the content downloading system. @@ -33,7 +38,7 @@ OpenTTD needs the Platform SDK, if it isn't installed already. This can be done during installing Visual Studio, by selecting `Visual C++ MFC for x86 and x64` (and possibly `Visual C++ ATL for x86 and x64` depending on your version). If not, you -can get download it as [MS Windows Platform SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk). +can get download it as [MS Windows Platform SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk). Install the SDK by following the instructions as given. @@ -45,6 +50,7 @@ by following the `Quick Start` instructions of their After this, you can install the dependencies OpenTTD needs. We advise to use the `static` versions, and OpenTTD currently needs the following dependencies: +- breakpad - liblzma - libpng - lzo @@ -53,8 +59,8 @@ the `static` versions, and OpenTTD currently needs the following dependencies: To install both the x64 (64bit) and x86 (32bit) variants (though only one is necessary), you can use: ```ps -.\vcpkg install liblzma:x64-windows-static libpng:x64-windows-static lzo:x64-windows-static zlib:x64-windows-static -.\vcpkg install liblzma:x86-windows-static libpng:x86-windows-static lzo:x86-windows-static zlib:x86-windows-static +.\vcpkg install --triplet=x64-windows-static +.\vcpkg install --triplet=x86-windows-static ``` You can open the folder (as a CMake project). CMake will be detected, and you can compile from there. @@ -97,7 +103,7 @@ Via CMake, several options can be influenced to get different types of builds. - `-DCMAKE_BUILD_TYPE=RelWithDebInfo`: build a release build. This is - significant faster than a debug build, but has far less useful information + significantly faster than a debug build, but has far less useful information in case of a crash. - `-DOPTION_DEDICATED=ON`: build OpenTTD without a GUI. Useful if you are running a headless server, as it requires less libraries to operate. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0ca0ab7..668d73d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ In return, they should reciprocate that respect in addressing your issue or asse The [issue tracker](https://github.com/OpenTTD/OpenTTD/issues) is the preferred channel for [bug reports](#bug-reports), but please respect the following restrictions: * Please **do not** use the issue tracker for help playing or using OpenTTD. -Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel), or the [forums](https://www.tt-forums.net/) +Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel), [Discord](https://discord.gg/openttd), or the [forums](https://www.tt-forums.net/) * Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. @@ -23,7 +23,7 @@ Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to We reserve the right to delete comments which violate this rule. * Please **do not** open issues or pull requests regarding add-on content in NewGRF, GameScripts, AIs, etc. -These are created by third-parties. Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel) or the [forums](https://www.tt-forums.net/) to discuss these. +These are created by third-parties. Please try [irc](https://wiki.openttd.org/en/Development/IRC%20channel), [Discord](https://discord.gg/openttd), or the [forums](https://www.tt-forums.net/) to discuss these. * Please use [the web translator](https://translator.openttd.org/) to submit corrections and improvements to translations of the game. @@ -108,11 +108,11 @@ Pull requests should fit with the [goals of the project](./CONTRIBUTING.md#proje Every pull request should have a clear scope, with no unrelated commits. -[Code style](https://wiki.openttd.org/en/Development/Coding%20style) must be complied with for pull requests to be accepted; this also includes [commit message format](https://wiki.openttd.org/en/Development/Coding%20style#commit-message). +[Code style](./CODINGSTYLE.md) must be complied with for pull requests to be accepted; this also includes [commit message format](./CODINGSTYLE.md#commit-message). Adhering to the following process is the best way to get your work included in the project: -1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes: +1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the project, clone your fork, and configure the remotes: ```bash git clone https://github.com//OpenTTD.git openttd @@ -136,7 +136,7 @@ contain your feature, change, or fix: git checkout upstream/master -b ``` -4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](https://wiki.openttd.org/en/Development/Coding%20style#commit-message) or your code is unlikely to be merged into the main project. +4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](./CODINGSTYLE.md#commit-message) or your code is unlikely to be merged into the main project. Use Git's [interactive rebase](https://docs.github.com/en/get-started/using-git/about-git-rebase) feature to tidy up your commits before making them public. 5. Locally rebase the upstream development branch into your topic branch: @@ -172,7 +172,7 @@ The results of the CI tests will show on your pull request. By clicking on Details you can further zoom in; in case of a failure it will show you why it failed. In case of success it will report how awesome you were. -Tip: [commit message format](https://wiki.openttd.org/en/Development/Coding%20style#commit-message) is a common reason for pull requests to fail validation. +Tip: [commit message format](./CODINGSTYLE.md#commit-message) is a common reason for pull requests to fail validation. ### Are there any development docs? @@ -182,6 +182,16 @@ There is no single source for OpenTTD development docs. It's a complex project w A good entry point is [Development](https://wiki.openttd.org/en/Development/) on the OpenTTD wiki; this provides links to wiki documentation and other sources. The GitHub repo also includes some non-comprehensive documentation in [/docs](./docs). +These include: +- When to [change other languages and when not to](./docs/eints.md). +- The [savegame format](./docs/savegame_format.md). +- The [release process](./docs/releasing_openttd.md). +- Some [notes on the link graph algorithm](./docs/linkgraph.md). +- The [network game coordinator](./docs/game_coordinator.md). +- How to use [the admin port for network games](./docs/admin_network.md), also useful for multiplayer server hosts. +- The [performance metrics and logging features](./docs/logging_and_performance_metrics.md), also useful for add-on developers. +- How [symbol server and analysis works](./docs/symbol_server.md). +- And several miscellaneous files detailing internal data structures and graphics measurements and palettes. You may also want the guide to [compiling OpenTTD](./COMPILING.md). @@ -256,7 +266,7 @@ This is inevitable, because it is a main feature of git. If you are concerned about your privacy, we strongly recommend to use "Anonymous <anonymous@openttd.org>" as the git commit author. We might refuse anonymous contributions if malicious intent is suspected. Please note that the contributor identity, once given, is used for copyright verification and to provide proof should a malicious commit be made. -As such, the [EU GDPR](https://www.eugdpr.org/key-changes.html) "right to be forgotten" does not apply, as this is an overriding legitimate interest. +As such, the [EU GDPR](https://gdpr.eu) "right to be forgotten" does not apply, as this is an overriding legitimate interest. Please also note that your commit is public and as such will potentially be processed by many third-parties. Git's distributed nature makes it impossible to track where exactly your commit, and thus your personal data, will be stored and be processed. diff --git a/COPYING.md b/COPYING.md index 2c2818d1..27885642 100644 --- a/COPYING.md +++ b/COPYING.md @@ -1,5 +1,5 @@ This is the license which applies to OpenTTD with the exception of some -3rd party modules. See [./README.md](./README.md) for details +3rd party modules. See [our readme](./README.md) for details GNU General Public License ========================== diff --git a/CREDITS.md b/CREDITS.md index 8826c9dc..1988223b 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -56,6 +56,7 @@ - George - Canal/Lock graphics - Andrew Parkhouse (andythenorth) - River graphics - David Dallaston (Pikka) - Tram tracks +- Richard Wheeler (zephyris) - OpenTTD TrueType font - All Translators - For their support to make OpenTTD a truly international game - Bug Reporters - Thanks for all bug reports - Chris Sawyer - For an amazing game! diff --git a/Doxyfile.in b/Doxyfile.in index 5a361d7f..b914947a 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -293,8 +293,8 @@ PREDEFINED = WITH_ZLIB \ WITH_PNG \ WITH_FONTCONFIG \ WITH_FREETYPE \ + WITH_HARFBUZZ \ WITH_ICU_I18N \ - WITH_ICU_LX \ UNICODE \ _UNICODE \ _GNU_SOURCE \ diff --git a/README.md b/README.md index 96f13730..1943ed6b 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,10 @@ - 1.6) [OpenTTD directories](#16-openttd-directories) - 1.7) [Compiling OpenTTD](#17-compiling-openttd) - 2.0) [Contact and community](#20-contact-and-community) - - 2.1) [Contributing to OpenTTD](#21-contributing-to-openttd) - - 2.2) [Reporting bugs](#22-reporting-bugs) - - 2.3) [Translating](#23-translating) + - 2.1) [Multiplayer games](#21-multiplayer-games) + - 2.2) [Contributing to OpenTTD](#22-contributing-to-openttd) + - 2.3) [Reporting bugs](#23-reporting-bugs) + - 2.4) [Translating](#24-translating) - 3.0) [Licensing](#30-licensing) - 4.0) [Credits](#40-credits) @@ -77,9 +78,9 @@ For some platforms, you will need to refer to [the installation guide](https://w The free data files, split into OpenGFX for graphics, OpenSFX for sounds and OpenMSX for music can be found at: -- https://www.openttd.org/downloads/opengfx-releases/latest for OpenGFX -- https://www.openttd.org/downloads/opensfx-releases/latest for OpenSFX -- https://www.openttd.org/downloads/openmsx-releases/latest for OpenMSX +- [OpenGFX](https://www.openttd.org/downloads/opengfx-releases/latest) +- [OpenSFX](https://www.openttd.org/downloads/opensfx-releases/latest) +- [OpenMSX](https://www.openttd.org/downloads/openmsx-releases/latest) Please follow the readme of these packages about the installation procedure. The Windows installer can optionally download and install these packages. @@ -117,6 +118,15 @@ Most types of add-on content can be downloaded within OpenTTD via the 'Check Onl Add-on content can also be installed manually, but that's more complicated; the [OpenTTD wiki](https://wiki.openttd.org/) may offer help with that, or the [OpenTTD directory structure guide](./docs/directory_structure.md). +### 1.5.1) Social Integration + +OpenTTD has the ability to load plugins to integrate with Social Platforms like Steam, Discord, etc. + +To enable such integration, the plugin for the specific platform has to be downloaded and stored in the `social_integration` folder. + +See [OpenTTD's website](https://www.openttd.org), under Downloads, for what plugins are available. + + ### 1.6) OpenTTD directories OpenTTD uses its own directory structure to store game data, add-on content etc. @@ -144,12 +154,19 @@ If you want to compile OpenTTD from source, instructions can be found in [COMPIL - the OpenTTD wiki has a [page listing OpenTTD communities](https://wiki.openttd.org/en/Community/Community) including some in languages other than English -### 2.1) Contributing to OpenTTD +### 2.1) Multiplayer games + +You can play OpenTTD with others, either cooperatively or competitively. + +See the [multiplayer documentation](./docs/multiplayer.md) for more details. + + +### 2.2) Contributing to OpenTTD We welcome contributors to OpenTTD. More information for contributors can be found in [CONTRIBUTING.md](./CONTRIBUTING.md) -### 2.2) Reporting bugs +### 2.3) Reporting bugs Good bug reports are very helpful. We have a [guide to reporting bugs](./CONTRIBUTING.md#bug-reports) to help with this. @@ -157,7 +174,7 @@ Desyncs in multiplayer are complex to debug and report (some software developmen Instructions can be found in [debugging and reporting desyncs](./docs/debugging_desyncs.md). -### 2.3) Translating +### 2.4) Translating OpenTTD is translated into many languages. Translations are added and updated via the [online translation tool](https://translator.openttd.org). @@ -174,12 +191,26 @@ See `src/3rdparty/squirrel/COPYRIGHT` for the complete license text. The md5 implementation in `src/3rdparty/md5` is licensed under the Zlib license. See the comments in the source files in `src/3rdparty/md5` for the complete license text. -The implementations of Posix `getaddrinfo` and `getnameinfo` for OS/2 in `src/3rdparty/os2` are distributed partly under the GNU Lesser General Public License 2.1, and partly under the (3-clause) BSD license. -The exact licensing terms can be found in `src/3rdparty/os2/getaddrinfo.c` resp. `src/3rdparty/os2/getnameinfo.c`. - The fmt implementation in `src/3rdparty/fmt` is licensed under the MIT license. See `src/3rdparty/fmt/LICENSE.rst` for the complete license text. +The nlohmann json implementation in `src/3rdparty/nlohmann` is licensed under the MIT license. +See `src/3rdparty/nlohmann/LICENSE.MIT` for the complete license text. + +The OpenGL API in `src/3rdparty/opengl` is licensed under the MIT license. +See `src/3rdparty/opengl/khrplatform.h` for the complete license text. + +The catch2 implementation in `src/3rdparty/catch2` is licensed under the Boost Software License, Version 1.0. +See `src/3rdparty/catch2/LICENSE.txt` for the complete license text. + +The icu scriptrun implementation in `src/3rdparty/icu` is licensed under the Unicode license. +See `src/3rdparty/icu/LICENSE` for the complete license text. + +The monocypher implementation in `src/3rdparty/monocypher` is licensed under the 2-clause BSD and CC-0 license. +See `src/3rdparty/monocypher/LICENSE.md` for the complete license text. + +The OpenTTD Social Integration API in `src/3rdparty/openttd_social_integration_api` is licensed under the MIT license. +See `src/3rdparty/openttd_social_integration_api/LICENSE` for the complete license text. ## 4.0 Credits diff --git a/bin/ai/CMakeLists.txt b/bin/ai/CMakeLists.txt index 08fd165d..7fb23cad 100644 --- a/bin/ai/CMakeLists.txt +++ b/bin/ai/CMakeLists.txt @@ -14,6 +14,7 @@ set(AI_COMPAT_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/compat_1.11.nut ${CMAKE_CURRENT_SOURCE_DIR}/compat_12.nut ${CMAKE_CURRENT_SOURCE_DIR}/compat_13.nut + ${CMAKE_CURRENT_SOURCE_DIR}/compat_14.nut ) foreach(AI_COMPAT_SOURCE_FILE IN LISTS AI_COMPAT_SOURCE_FILES) diff --git a/bin/ai/compat_13.nut b/bin/ai/compat_13.nut index 3081fb58..5f808e38 100644 --- a/bin/ai/compat_13.nut +++ b/bin/ai/compat_13.nut @@ -4,3 +4,5 @@ * 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. * 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 . */ + +AILog.Info("13 API compatibility in effect."); diff --git a/bin/ai/compat_14.nut b/bin/ai/compat_14.nut new file mode 100644 index 00000000..3081fb58 --- /dev/null +++ b/bin/ai/compat_14.nut @@ -0,0 +1,6 @@ +/* + * This file is part of OpenTTD. + * 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. + * 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. + * 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 . + */ diff --git a/bin/game/CMakeLists.txt b/bin/game/CMakeLists.txt index c1134ed2..0b48e978 100644 --- a/bin/game/CMakeLists.txt +++ b/bin/game/CMakeLists.txt @@ -11,6 +11,7 @@ set(GS_COMPAT_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/compat_1.11.nut ${CMAKE_CURRENT_SOURCE_DIR}/compat_12.nut ${CMAKE_CURRENT_SOURCE_DIR}/compat_13.nut + ${CMAKE_CURRENT_SOURCE_DIR}/compat_14.nut ) foreach(GS_COMPAT_SOURCE_FILE IN LISTS GS_COMPAT_SOURCE_FILES) diff --git a/bin/game/compat_13.nut b/bin/game/compat_13.nut index 3081fb58..0ee9faf2 100644 --- a/bin/game/compat_13.nut +++ b/bin/game/compat_13.nut @@ -4,3 +4,5 @@ * 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. * 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 . */ + +GSLog.Info("13 API compatibility in effect."); diff --git a/bin/game/compat_14.nut b/bin/game/compat_14.nut new file mode 100644 index 00000000..3081fb58 --- /dev/null +++ b/bin/game/compat_14.nut @@ -0,0 +1,6 @@ +/* + * This file is part of OpenTTD. + * 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. + * 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. + * 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 . + */ diff --git a/changelog.txt b/changelog.txt index b4eba499..93f314b3 100644 --- a/changelog.txt +++ b/changelog.txt @@ -1,3 +1,285 @@ +14.0-beta1 (2023-02-03) +------------------------------------------------------------------------ +Feature: Order option to unbunch vehicles at depot (#11945) +Feature: Infinite money mode (#11902) +Feature: Setting to disable the loading speed penalty for trains longer than the station (#11682) +Feature: Plugin framework for Social Integration with Steam, Discord, GOG, etc (#11628) +Feature: Scalable OpenTTD TrueType font made by Zephyris (#11593) +Feature: Toyland-specific river graphics (#11523) +Feature: Add zoom level buttons to sprite aligner (#11518) +Feature: Add shading to river slopes (#11491) +Feature: Place cargo icon on cargo filter dropdowns (#11487) +Feature: Mode to display timetable in seconds (#11435) +Feature: Setting to influence how many minutes a calendar year takes (#11428) +Feature: Base graphics can offer parameters for additional settings (#11347) +Feature: Sandbox option to lock station ratings at 100% (#11346) +Feature: Setting to use real-time "wallclock" as timekeeping units (#11341) +Feature: Setting to automatically restart server based on hours played (#11142) +Feature: Add config option to set default company secondary colour for new games (#11068) +Feature: Transparency option for cost and income indicators (#11001) +Feature: Create group of vehicles from manage vehicle list button (#10890) +Feature: Show coverage highlight the same as stations when adding waypoints (#10875) +Feature: Show the number of industries already built in the Fund New Industry window (#10806) +Feature: Add search filter and name text to build waypoint window (#10786) +Feature: Setting to disallow level crossings with competitors (#10755) +Feature: Opt-in survey when leaving a game (#10719) +Feature: Replace buying/selling company shares with hostile takeovers of AI companies (#10709, #10914) +Feature: Settings to scale cargo production of towns and industries (#10606) +Feature: Separate rail/road and sea/air velocity units, and add knots (#10594) +Feature: Region-based pathfinder for ships (#10543) +Feature: Filter engine build menu by name and NewGRF extra text (#10519) +Feature: Industry directory text filter (#10518) +Feature: Ctrl+Click to reset late counter for the entire vehicle group (#10464) +Feature: Orientation of rail and road depots can be changed (#9642) +Feature: Display help and manuals in-game (#7786) +Feature: [NewGRF] Town production effect and multiplier (#11947) +Feature: [NewGRF] Randomize direction of rail vehicle on build based on probability callback (#11489) +Feature: [NewGRF] Related Act2 objects for airports and airport tiles (#11282) +Feature: [NewGRF] Allow higher max speeds for ships (#10734) +Feature: [NewGRF] Increase limit of objects/stations/roadstops per NewGRF (#10672) +Feature: [NewGRF] Road stops (#10144) +Feature: [Script] Goal destination can be updated (#10817) +Add: Argument for console command "restart" to use either current or newgame settings (#11962, #11963) +Add: {CURRENCY_SHORT} only did k / m suffix. Add bn / tn and make translatable (#11921) +Add: Show in multiplayer the amount of hours a game has been unpaused (#11886) +Add: Allow loading heightmaps from command-line (#11870) +Add: List_[scenario|heightmap] and load_[scenario|height] console commands (#11867) +Add: Latvian Lats currency (#11691) +Add: Horizontal scroll for script debug log (#11597) +Add: GUI options to select sprite font and AA mode for all fonts (#11593) +Add: Website button for basesets in Game Options window, the Game Script settings window and AI settings window (#11512) +Add: [Emscripten] Support for bootstrapping (#11109) +Add: Hotkey to focus town / industry directory filter box (#11030) +Add: Maximum number of companies allowed to the client list (#10523) +Add: Use specific error message when vehicle cannot go to station/waypoint (#10494) +Add: Show NewGRF name in NewGRF-created errors (#10457) +Add: Alternative setting for right-click close window option to exclude pinned windows (#10204) +Add: Allow autoreplace with same model vehicle (#7729) +Add: [NewGRF] Allow inspection of road tiles and airports (#11282, #11323) +Add: [NewGRF] Station variable 6B to get extended station id of nearby tiles (#10953) +Add: [NewGRF] String code "9A 21" to display force from textstack (#10782) +Add: [NewGRF] Station property 1C/1D to set name/classname (#10672) +Add: [Script] Optional filter parameter to ScriptXXXList constructors (#11698,#11663) +Add: [Script] AI/GS Time Mode to choose between economy (default) and calendar time (#11603) +Add: [Script] Allow to set max loan for each company separately (#11224) +Add: [Script] GSIndustry.GetConstructionDate() method (#11145) +Add: [Script] Game script control of industry production level and news messages (#11141) +Add: [Script] GSAsyncMode to set async mode of gamescript commands (#10913) +Add: [Script] GSCompanyMode::IsValid and IsDeity, and enforce valid company/deity mode where applicable (#10536, #10529) +Add: [Script] Allow GS to found town with random road layout (#10442) +Add: [Script] Create own Randomizer per instance (#10349) +Change: Better handle different GUI sizes for most windows, and squash inconsistencies between windows +Change: Allow configuring AI slots above the current maximum number of competitors (#11961) +Change: Forcefully enable prefixing logs with date (#11930) +Change: Position error window closer to cursor on large screens (#11923) +Change: Only open story-book in center when a GS does it (#11916) +Change: Rebrand Cheats as Sandbox Options (#11874) +Change: Make smooth-scrolling based on actual time (#11865) +Change: Set smooth-scrolling on by default (#11860) +Change: Disable building rail infrastructure if train build limit is zero (#11847) +Change: Invalidate music volume when restarting music playback on Windows (#11836) +Change: Make street lights transparent with houses (#11828) +Change: Redesign script debug window (#11782) +Change: Reorganize Settings menu items (#11683) +Change: Set amount of smoke/sparks to "realistic" by default (#11624) +Change: Show a message in livery window if vehicle type has no groups (#11617) +Change: Add distinct tooltips for vehicle group colour schemes (#11617) +Change: Move colour selection dropdowns to bottom of window (#11617) +Change: Support custom transparency remaps with 32bpp blitters (#11616) +Change: Make "middle" the default stopping location for trains in platforms (#11605) +Change: Scale sprites to requested highest resolution level (#11600) +Change: Allow opening multiple script debug windows by holding Ctrl (#11592) +Change: Don't show scoring year in high score table (#11546) +Change: Revert pressed-button content shifting introduced in r2161 (#11542) +Change: Show rating in station list even with no cargo waiting (#11540) +Change: Hide unused cargos from vehicle cargo filter (#11533) +Change: Don't restart playback when toggling playlist shuffle (#11504) +Change: Increase finance window lines (and underlines) with interface scale (#11459) +Change: Move baseset missing/corrupted files label to list item (#11455) +Change: Add horizontal scrollbar to Industry Directory window (#11434) +Change: Improve layout of airport, dock, object, road/tram stop, train station pickers (#11430) +Change: Display cargo lists in sorted cargo order (#11383) +Change: Link houses production on industry chain graph by TPE_PASSENGERS or TPE_MAIL cargo (#11378) +Change: Passenger subsidies are generated for any TPE_PASSENGER cargo type (#11378) +Change: Towns generate cargo based on town production effect (#11378) +Change: Always allow expanding towns in Scenario Editor to build new roads (#11377) +Change: Don't set vehicle on time if timetable not started (#11359) +Change: Store station blocked/wires/pylons flags in map (#11337) +Change: Recover when possible from crashes during a crash (#11238) +Change: Store crash logs in JSON format (#11232) +Change: Remove autosave from settings window; it is already in the Game Options (#11218) +Change: Enable "Forbid 90 degree turns" setting by default (#11160) +Change: Do not allow mixing road/tram types in powered road type list (#11148) +Change: Only show platform stopping location in orders when other than default (#11102) +Change: Autorail / autoroad tools can start dragging from invalid tiles (#11089) +Change: Only allow buying Exclusive Transport Rights when no one has them (#11076) +Change: Remove currency code/symbol suffix from language files (#11061) +Change: Add separate setting for server sent commands per frame limit (#11023) +Change: Cargo flow legend only shows defined cargo (#10872) +Change: Use "Via-Destination-Source" as default station cargodist display (#10851) +Change: Preserve orders and related settings where possible when moving engines around in a train (#10799) +Change: Standardise unit conversions and allow decimal places (#10795) +Change: Use separate names for default stations/roadstops (#10786) +Change: [MacOS] Require at least 10.15 to run the game (#10745) +Change: Hide all variants from UI when (display) parent is hidden (#10708) +Change: Split Game options into General, Graphics and Sound tabs (#10674) +Change: Extend entity override manager and station spec lists to support 16 bit IDs (#10672) +Change: Base autosaves intervals on real time (instead of game time) (#10655) +Change: Allow overbuilding station and waypoint tiles (#10618) +Change: Use realtime for Linkgraph update settings (#10610) +Change: Make tick length 27 milliseconds (#10607) +Change: Increase max cargo age and let min cargo payment approach zero (#10596) +Change: Show buy company dialog window even when playing in the AI company (#10459) +Change: Use HTTPS for content-service connections (#10448) +Change: Big UFO disaster targets current location of a random train (#10290) +Change: Remove land generator setting from World Generation GUI (#10093) +Change: Build signals to the next junction when dragging regardless of the Ctrl state (#9637) +Change: Allow dedicated server to use threaded saves (#10787) +Change: [NewGRF] Increase vehicle random data from 8 to 16 bits (#10701) +Change: [NewGRF] Read Action 3 IDs as extended-bytes for all features (#10672) +Change: [NewGRF] Make Action 3 debug messages more consistent (#10672) +Change: [NewGRF] Extend callback 161 (engine name) with bit 0x22 for context 'Autoreplace - Vehicles in use' (#10666) +Change: [Script] Replace easy/medium/hard values with default value (#11959) +Change: [Script] Limit total script ops that can be consumed by a list valuate (#11670) +Change: [Script] Allow GS access to ScriptGroup, ScriptGameSettings.IsDisabledVehicleType, more ScriptCompany and more ScriptOrder functions (#10642) +Change: [Script] Improve ScriptText validation error messages (#10545) +Change: [Script] Restore support of {RAW_STRING} in ScriptText (#10492) +Change: [Script] Validate ScriptText parameters type and amount (#10492) +Change: [Script] Automate the ScriptObject reference counting (#10492) +Change: [Script] Extract params info from GS strings (#10492) +Change: [Script] A ScriptText with too many parameters is now a fatal error (#10483) +Change: [Script] Log AI/GS Squirrel crashes in white text for readability (#10375) +Fix #11918: Houses should only build next to road stops, not any station type (#11919) +Fix #11827: Make text layouter aware of ligatures (#11831) +Fix #11752: Characters could be repeated when wrapping multi-line text (#11761) +Fix #11748: Decreasing service interval value sufficiently would result in it wrapping around (#11749) +Fix #11629: Crash when getting the nearest town for rotated airports (#11631) +Fix #11516: Adjust window size by interface scale during ReInit (#11517) +Fix #11515: Changing interface scale could have unintended effects on zoom level (#11615) +Fix #11442: "Default" colour in group colour window is not updated when changing master colour (#11614) +Fix #11437: Flipped shorter rail vehicles disappear in windows (#11446) +Fix #11413: Incorrect sorting by industry production (#11414) +Fix #11407: Don't steal focus from dropdown menus (#11484) +Fix #11402: Make string filter locale-aware (#11426) +Fix #11329: Don't assert vehicle list length is non-zero when only asked to set string parameter (#11330) +Fix #11315: Sort industries and cargoes by name in industry chain window (#11317) +Fix #11307: Incorrect GroupStatistics after selling leading wagon (#11311) +Fix #11261: Airport menu selectability after closing window on a class with no available airports (#11344) +Fix #11230: Sort by button in group list window could be misaligned (#11231) +Fix #11215: Assert in NewGRF parameters window (manual parameter mode) (#11217) +Fix #11203: [Linux] Crash when editing CJK characters in edit box (#11204) +Fix #11180: Aircraft crashes could point to the wrong tile (#11184) +Fix #11164: Don't create duplicate town names when using 'Many random towns' in the scenario editor (#11165) +Fix #11162: Second company colour was not consistently applied to articulated vehicles (#11163) +Fix #11115: Focus the abandon game/exit game windows (#11125) +Fix #11096: Increase priority of error and confirmation windows (#11104) +Fix #11087: Disable base graphics/sound dropdown outside main menu (#11091) +Fix #11054: Prevent translation of currency codes (#11061) +Fix #11026: Use real engine name instead of default name for filtering (#11033) +Fix #10982: No help text for gamelog command (#10984) +Fix #10880: Crash in object window due to incorrect parameter order (#10881) +Fix #10868: Crash when Script tries to load large savegame data (#11029) +Fix #10811: Allow dragging vehicle in depot to any free row (#11508) +Fix #10660: Sprite Font scale affected by viewport zoom level limits (#10668) +Fix #10619: Crash loading linkgraph for older savegames (#10620) +Fix #10600: 'Replace Vehicles' didn't show numbers >999 (#10680) +Fix #10578: Allow to select any version of AI/GS from GUI (#10604) +Fix #10522: Link graph tooltip vertical lines were not handled correctly (#10524) +Fix #10511: Don't search for depot every tick if one cannot be found (#11548) +Fix #10478: Clarify airport noise control setting texts (#11169) +Fix #10452: Prevent long stalls during river generation (#11544) +Fix #10430: Display chain window causing assert (#10431) +Fix #10343: Don't extend town-disallowed roadtypes (#10347) +Fix #10251: [MacOS] Screen looks blue-ish when using newer SDKs (#11207) +Fix #10222: Adjust line drawing algorithm (#10491) +Fix #10131: Actually cancel downloads when pressing cancel (#10485) +Fix #10118: Cycle through current signal group, not just path signals (#11798) +Fix #10439: [Script] Validate story page button colour, flags, cursor and vehicle type (#11892) +Fix #10438: [Script] Validate story page element type for ScriptStoryPage::NewElement (#11888) +Fix #9865: Removing files with the console always failed +Fix #9810: Rebuilding a through road stop costs money (#9852) +Fix #9722: Crash when pressing hotkeys early in world generation (#11858) +Fix #9697: Limit the default width of the Online Players window (#11936) +Fix #9642: Keep infrastructure totals when overbuilding road depots (#11229) +Fix #9545: Crash when all cargo types are disabled (#11432) +Fix #8846: When upgrading NewGRF presets, copy NewGRF parameters only if the NewGRF are compatible (#11348) +Fix #8253: Improve profit graph when having lots of money (#11915) +Fix #6377: Two tarballs with the same folder in them were considered as one (#11855) +Fix #5713: Ships could be sent to unreachable depots (#11768) +Fix #4575: Use Latin 'l' in English translation of zloty (#11090) +Fix #4415: Land info build date is also renovation date (#11759) +Fix: Display rank correctly with more than 15 companies in a league table (#11940) +Fix: Extra refit button when train/RV is in a depot (#11904) +Fix: Update server listing as offline when unexpected disconnect during refresh (#11891) +Fix: Horizontal scale of framerate window switched excessively (#11813) +Fix: [Linux] Various issues with resolutions and fullscreen in multi-display setups (#11778, #11779) +Fix: Build button text when train purchase window using "Engines" filter (#11755) +Fix: One-way state remained after removing road from road and tram tile (#11745) +Fix: Draw video driver info at the correct size and text wrap (#10716) +Fix: Language genders could not be applied to SCC_INDUSTRY_NAME (#11697) +Fix: Spurious cancellations of HTTP content downloads (#11668) +Fix: Calculation of initial engine age was inaccurate (#11660) +Fix: Prevent underflow if engine base life is less than 8 years (#11635) +Fix: Changing default livery did not propagate to group liveries (#11633) +Fix: Window width/height was doubly-scaled with automatic DPI switch (#11598) +Fix: Don't crash when saving a crashlog save with no main window open (#11586) +Fix: Prevent overflow when calculating max town noise (#11564) +Fix: Deleting towns did not check for waypoints referencing the town (#11513) +Fix: Invalidate playlist window when (un)shuffling playlist (#11504) +Fix: Restore original cargo legend 'blob' dimensions (#11480) +Fix: Extmidi did not move on to next song after playing ends (#11469) +Fix: Server password length in the UI was unnecessarily limited (#11408) +Fix: OpenTTD can fail to exit on an error due to mutex locks in threads (#11398) +Fix: Scale minimum width for server name by interface scale (#11381) +Fix: Server connection was not closed when relay window was closed (#11366) +Fix: Upgrading NewGRF presets could result in incomplete display of NewGRF parameters until restart (#11348) +Fix: Check for engine variant loops during NewGRF initialization (#11343) +Fix: Don't allow industries to produce invalid cargo (#11314) +Fix: Also apply cargo filters on shared groups in vehicle listing (#11294) +Fix: Only count distance traveled in vehicles for cargo payment (#11283) +Fix: Base cargo payment on load/unload tile, instead of station sign location (#11281) +Fix: Crash when opening a damaged base-graphics (#11275) +Fix: Trivial autoreplace of mixed cargo articulated engines (#11253) +Fix: [Emscripten] Config not saved on exit (#11248) +Fix: Inaccurate waiting cargo total in station window when using cargodist (#11213) +Fix: No fast forward in network was ensured only from GUI side (#11206) +Fix: Crash when not passing command-line parameter for -n (#11153) +Fix: [Bootstrap] Don't crash when failing to connect to content server (#11122) +Fix: Crash when failing to load a game into a dedicated server at startup (#11021) +Fix: Don't allow changing settings over the network that are marked as local settings (#11009) +Fix: Move no_http_content_downloads and use_relay_service to private settings (#10762) +Fix: Extra viewport could not be scrolled with right-click-close (#10644) +Fix: Specify units for value of share trading age setting (#10612) +Fix: Road type is not available before its introduction date (#10585) +Fix: Do not update a RV's Z-position when stationary while turning (#10570) +Fix: Don't (briefly) switch from title-only playlist on menu screen (#10553) +Fix: Reset content download progress to zero if falling back to TCP (#10485) +Fix: Make script goals work with the whole range of ClientIDs (#10435) +Fix: [NewGRF] Tile slope missing from road stops varact2 variable 0x42 (#11373) +Fix: [NewGRF] House class mappings were not reset between games (#11279) +Fix: [NewGRF] Profile didn't stop if there were no events yet (#10816) +Fix: [NewGRF] Support more than 256 stations/waypoints/roadstops per class (#10793) +Fix: [NewGRF] Var68 for station and roadstop was broken (#10784) +Fix: [NewGRF] Object and road stop ignore property handlers (#10525) +Fix: [Script] Apply random deviation to settings only at script start (#11944) +Fix: [Script] Improve ScriptText validation (#11721) +Fix: [Script] GSAdmin.Send() could generate invalid JSON (#11250) +Fix: [Script] Crash if squirrel compatibility scripts cannot be parsed (#11589) +Fix: [Script] Don't list unavailable road types for game scripts (#10585) +Fix: [Script] Game scripts were able to build with non-existing road types (#10539) +Fix: [Script] Inconsistent precondition failure return values (#10533) +Fix: [Script] Crash when companies disappear (#10529) +Fix: [Script] ScriptBase::Rand() return value could return negative values (#10443) +Fix: [Script] Incorrect value for GOAL_INVALID (#10436) +Fix: [Script] Extend Script::IsValidVehicle to check for primary vehicles (#10386) +Remove: "generation_seed" from config, as it was a write-only value (#11927) +Remove: Debug redirect over network (#11776) +Remove: Officially mark Vista as no longer supported (#11531) +Remove: OS/2 and SunOS ports (#11018, #11210) +Remove: Obsolete NewGRF text unprinting (#10884) +Remove: [Script] CONFIG_RANDOM from AddSetting flags (#11942) + + 13.4 (2023-07-29) ------------------------------------------------------------------------ Fix: Setting tree lines drawn incorrectly for RTL languages (#11070) diff --git a/cmake/Catch.cmake b/cmake/Catch.cmake new file mode 100644 index 00000000..6f21a89c --- /dev/null +++ b/cmake/Catch.cmake @@ -0,0 +1,206 @@ +# Distributed under the OSI-approved BSD 3-Clause License. See accompanying +# file Copyright.txt or https://cmake.org/licensing for details. + +#[=======================================================================[.rst: +Catch +----- + +This module defines a function to help use the Catch test framework. + +The :command:`catch_discover_tests` discovers tests by asking the compiled test +executable to enumerate its tests. This does not require CMake to be re-run +when tests change. However, it may not work in a cross-compiling environment, +and setting test properties is less convenient. + +This command is intended to replace use of :command:`add_test` to register +tests, and will create a separate CTest test for each Catch test case. Note +that this is in some cases less efficient, as common set-up and tear-down logic +cannot be shared by multiple test cases executing in the same instance. +However, it provides more fine-grained pass/fail information to CTest, which is +usually considered as more beneficial. By default, the CTest test name is the +same as the Catch name; see also ``TEST_PREFIX`` and ``TEST_SUFFIX``. + +.. command:: catch_discover_tests + + Automatically add tests with CTest by querying the compiled test executable + for available tests:: + + catch_discover_tests(target + [TEST_SPEC arg1...] + [EXTRA_ARGS arg1...] + [WORKING_DIRECTORY dir] + [TEST_PREFIX prefix] + [TEST_SUFFIX suffix] + [PROPERTIES name1 value1...] + [TEST_LIST var] + [REPORTER reporter] + [OUTPUT_DIR dir] + [OUTPUT_PREFIX prefix} + [OUTPUT_SUFFIX suffix] + ) + + ``catch_discover_tests`` sets up a post-build command on the test executable + that generates the list of tests by parsing the output from running the test + with the ``--list-test-names-only`` argument. This ensures that the full + list of tests is obtained. Since test discovery occurs at build time, it is + not necessary to re-run CMake when the list of tests changes. + However, it requires that :prop_tgt:`CROSSCOMPILING_EMULATOR` is properly set + in order to function in a cross-compiling environment. + + Additionally, setting properties on tests is somewhat less convenient, since + the tests are not available at CMake time. Additional test properties may be + assigned to the set of tests as a whole using the ``PROPERTIES`` option. If + more fine-grained test control is needed, custom content may be provided + through an external CTest script using the :prop_dir:`TEST_INCLUDE_FILES` + directory property. The set of discovered tests is made accessible to such a + script via the ``_TESTS`` variable. + + The options are: + + ``target`` + Specifies the Catch executable, which must be a known CMake executable + target. CMake will substitute the location of the built executable when + running the test. + + ``TEST_SPEC arg1...`` + Specifies test cases, wildcarded test cases, tags and tag expressions to + pass to the Catch executable with the ``--list-test-names-only`` argument. + + ``EXTRA_ARGS arg1...`` + Any extra arguments to pass on the command line to each test case. + + ``WORKING_DIRECTORY dir`` + Specifies the directory in which to run the discovered test cases. If this + option is not provided, the current binary directory is used. + + ``TEST_PREFIX prefix`` + Specifies a ``prefix`` to be prepended to the name of each discovered test + case. This can be useful when the same test executable is being used in + multiple calls to ``catch_discover_tests()`` but with different + ``TEST_SPEC`` or ``EXTRA_ARGS``. + + ``TEST_SUFFIX suffix`` + Similar to ``TEST_PREFIX`` except the ``suffix`` is appended to the name of + every discovered test case. Both ``TEST_PREFIX`` and ``TEST_SUFFIX`` may + be specified. + + ``PROPERTIES name1 value1...`` + Specifies additional properties to be set on all tests discovered by this + invocation of ``catch_discover_tests``. + + ``TEST_LIST var`` + Make the list of tests available in the variable ``var``, rather than the + default ``_TESTS``. This can be useful when the same test + executable is being used in multiple calls to ``catch_discover_tests()``. + Note that this variable is only available in CTest. + + ``REPORTER reporter`` + Use the specified reporter when running the test case. The reporter will + be passed to the Catch executable as ``--reporter reporter``. + + ``OUTPUT_DIR dir`` + If specified, the parameter is passed along as + ``--out dir/`` to Catch executable. The actual file name is the + same as the test name. This should be used instead of + ``EXTRA_ARGS --out foo`` to avoid race conditions writing the result output + when using parallel test execution. + + ``OUTPUT_PREFIX prefix`` + May be used in conjunction with ``OUTPUT_DIR``. + If specified, ``prefix`` is added to each output file name, like so + ``--out dir/prefix``. + + ``OUTPUT_SUFFIX suffix`` + May be used in conjunction with ``OUTPUT_DIR``. + If specified, ``suffix`` is added to each output file name, like so + ``--out dir/suffix``. This can be used to add a file extension to + the output e.g. ".xml". + +#]=======================================================================] + +#------------------------------------------------------------------------------ +function(catch_discover_tests TARGET) + cmake_parse_arguments( + "" + "" + "TEST_PREFIX;TEST_SUFFIX;WORKING_DIRECTORY;TEST_LIST;REPORTER;OUTPUT_DIR;OUTPUT_PREFIX;OUTPUT_SUFFIX" + "TEST_SPEC;EXTRA_ARGS;PROPERTIES" + ${ARGN} + ) + + if(NOT _WORKING_DIRECTORY) + set(_WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}") + endif() + if(NOT _TEST_LIST) + set(_TEST_LIST ${TARGET}_TESTS) + endif() + + ## Generate a unique name based on the extra arguments + string(SHA1 args_hash "${_TEST_SPEC} ${_EXTRA_ARGS} ${_REPORTER} ${_OUTPUT_DIR} ${_OUTPUT_PREFIX} ${_OUTPUT_SUFFIX}") + string(SUBSTRING ${args_hash} 0 7 args_hash) + + # Define rule to generate test list for aforementioned test executable + set(ctest_include_file "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_include-${args_hash}.cmake") + set(ctest_tests_file "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_tests-${args_hash}.cmake") + get_property(crosscompiling_emulator + TARGET ${TARGET} + PROPERTY CROSSCOMPILING_EMULATOR + ) + add_custom_command( + TARGET ${TARGET} POST_BUILD + BYPRODUCTS "${ctest_tests_file}" + COMMAND "${CMAKE_COMMAND}" + -D "TEST_TARGET=${TARGET}" + -D "TEST_EXECUTABLE=$" + -D "TEST_EXECUTOR=${crosscompiling_emulator}" + -D "TEST_WORKING_DIR=${_WORKING_DIRECTORY}" + -D "TEST_SPEC=${_TEST_SPEC}" + -D "TEST_EXTRA_ARGS=${_EXTRA_ARGS}" + -D "TEST_PROPERTIES=${_PROPERTIES}" + -D "TEST_PREFIX=${_TEST_PREFIX}" + -D "TEST_SUFFIX=${_TEST_SUFFIX}" + -D "TEST_LIST=${_TEST_LIST}" + -D "TEST_REPORTER=${_REPORTER}" + -D "TEST_OUTPUT_DIR=${_OUTPUT_DIR}" + -D "TEST_OUTPUT_PREFIX=${_OUTPUT_PREFIX}" + -D "TEST_OUTPUT_SUFFIX=${_OUTPUT_SUFFIX}" + -D "CTEST_FILE=${ctest_tests_file}" + -P "${_CATCH_DISCOVER_TESTS_SCRIPT}" + VERBATIM + ) + + file(WRITE "${ctest_include_file}" + "if(EXISTS \"${ctest_tests_file}\")\n" + " include(\"${ctest_tests_file}\")\n" + "else()\n" + " add_test(${TARGET}_NOT_BUILT-${args_hash} ${TARGET}_NOT_BUILT-${args_hash})\n" + "endif()\n" + ) + + if(NOT ${CMAKE_VERSION} VERSION_LESS "3.10.0") + # Add discovered tests to directory TEST_INCLUDE_FILES + set_property(DIRECTORY + APPEND PROPERTY TEST_INCLUDE_FILES "${ctest_include_file}" + ) + else() + # Add discovered tests as directory TEST_INCLUDE_FILE if possible + get_property(test_include_file_set DIRECTORY PROPERTY TEST_INCLUDE_FILE SET) + if (NOT ${test_include_file_set}) + set_property(DIRECTORY + PROPERTY TEST_INCLUDE_FILE "${ctest_include_file}" + ) + else() + message(FATAL_ERROR + "Cannot set more than one TEST_INCLUDE_FILE" + ) + endif() + endif() + +endfunction() + +############################################################################### + +set(_CATCH_DISCOVER_TESTS_SCRIPT + ${CMAKE_CURRENT_LIST_DIR}/CatchAddTests.cmake + CACHE INTERNAL "Catch2 full path to CatchAddTests.cmake helper file" +) diff --git a/cmake/CatchAddTests.cmake b/cmake/CatchAddTests.cmake new file mode 100644 index 00000000..7faeedbd --- /dev/null +++ b/cmake/CatchAddTests.cmake @@ -0,0 +1,135 @@ +# Distributed under the OSI-approved BSD 3-Clause License. See accompanying +# file Copyright.txt or https://cmake.org/licensing for details. + +set(prefix "${TEST_PREFIX}") +set(suffix "${TEST_SUFFIX}") +set(spec ${TEST_SPEC}) +set(extra_args ${TEST_EXTRA_ARGS}) +set(properties ${TEST_PROPERTIES}) +set(reporter ${TEST_REPORTER}) +set(output_dir ${TEST_OUTPUT_DIR}) +set(output_prefix ${TEST_OUTPUT_PREFIX}) +set(output_suffix ${TEST_OUTPUT_SUFFIX}) +set(script) +set(suite) +set(tests) + +function(add_command NAME) + set(_args "") + # use ARGV* instead of ARGN, because ARGN splits arrays into multiple arguments + math(EXPR _last_arg ${ARGC}-1) + foreach(_n RANGE 1 ${_last_arg}) + set(_arg "${ARGV${_n}}") + if(_arg MATCHES "[^-./:a-zA-Z0-9_]") + set(_args "${_args} [==[${_arg}]==]") # form a bracket_argument + else() + set(_args "${_args} ${_arg}") + endif() + endforeach() + set(script "${script}${NAME}(${_args})\n" PARENT_SCOPE) +endfunction() + +# Run test executable to get list of available tests +if(NOT EXISTS "${TEST_EXECUTABLE}") + message(FATAL_ERROR + "Specified test executable '${TEST_EXECUTABLE}' does not exist" + ) +endif() +execute_process( + COMMAND ${TEST_EXECUTOR} "${TEST_EXECUTABLE}" ${spec} --list-test-names-only + OUTPUT_VARIABLE output + RESULT_VARIABLE result + WORKING_DIRECTORY "${TEST_WORKING_DIR}" +) +# Catch --list-test-names-only reports the number of tests, so 0 is... surprising +if(${result} EQUAL 0) + message(WARNING + "Test executable '${TEST_EXECUTABLE}' contains no tests!\n" + ) +elseif(${result} LESS 0) + message(FATAL_ERROR + "Error running test executable '${TEST_EXECUTABLE}':\n" + " Result: ${result}\n" + " Output: ${output}\n" + ) +endif() + +string(REPLACE "\n" ";" output "${output}") + +# Run test executable to get list of available reporters +execute_process( + COMMAND ${TEST_EXECUTOR} "${TEST_EXECUTABLE}" ${spec} --list-reporters + OUTPUT_VARIABLE reporters_output + RESULT_VARIABLE reporters_result + WORKING_DIRECTORY "${TEST_WORKING_DIR}" +) +if(${reporters_result} EQUAL 0) + message(WARNING + "Test executable '${TEST_EXECUTABLE}' contains no reporters!\n" + ) +elseif(${reporters_result} LESS 0) + message(FATAL_ERROR + "Error running test executable '${TEST_EXECUTABLE}':\n" + " Result: ${reporters_result}\n" + " Output: ${reporters_output}\n" + ) +endif() +string(FIND "${reporters_output}" "${reporter}" reporter_is_valid) +if(reporter AND ${reporter_is_valid} EQUAL -1) + message(FATAL_ERROR + "\"${reporter}\" is not a valid reporter!\n" + ) +endif() + +# Prepare reporter +if(reporter) + set(reporter_arg "--reporter ${reporter}") +endif() + +# Prepare output dir +if(output_dir AND NOT IS_ABSOLUTE ${output_dir}) + set(output_dir "${TEST_WORKING_DIR}/${output_dir}") + if(NOT EXISTS ${output_dir}) + file(MAKE_DIRECTORY ${output_dir}) + endif() +endif() + +# Parse output +foreach(line ${output}) + set(test ${line}) + # Escape characters in test case names that would be parsed by Catch2 + set(test_name ${test}) + foreach(char , [ ]) + string(REPLACE ${char} "\\${char}" test_name ${test_name}) + endforeach(char) + # ...add output dir + if(output_dir) + string(REGEX REPLACE "[^A-Za-z0-9_]" "_" test_name_clean ${test_name}) + set(output_dir_arg "--out ${output_dir}/${output_prefix}${test_name_clean}${output_suffix}") + endif() + + # ...and add to script + add_command(add_test + "${prefix}${test}${suffix}" + ${TEST_EXECUTOR} + "${TEST_EXECUTABLE}" + "${test_name}" + ${extra_args} + "${reporter_arg}" + "${output_dir_arg}" + ) + add_command(set_tests_properties + "${prefix}${test}${suffix}" + PROPERTIES + WORKING_DIRECTORY "${TEST_WORKING_DIR}" + ${properties} + ) + list(APPEND tests "${prefix}${test}${suffix}") +endforeach() + +# Create a list of all discovered tests, which users may use to e.g. set +# properties on the tests +add_command(set ${TEST_LIST} ${tests}) + +# Write CTest script +file(WRITE "${CTEST_FILE}" "${script}") diff --git a/cmake/CheckAtomic.cmake b/cmake/CheckAtomic.cmake index 52d93f4f..990c52c3 100644 --- a/cmake/CheckAtomic.cmake +++ b/cmake/CheckAtomic.cmake @@ -83,5 +83,5 @@ else() endif() if(HAVE_CXX_ATOMICS_WITH_LIB OR HAVE_CXX_ATOMICS64_WITH_LIB) - target_link_libraries(openttd atomic) + target_link_libraries(openttd_lib atomic) endif() diff --git a/cmake/CompileFlags.cmake b/cmake/CompileFlags.cmake index 6a942b21..a85a915c 100644 --- a/cmake/CompileFlags.cmake +++ b/cmake/CompileFlags.cmake @@ -4,23 +4,6 @@ # macro(compile_flags) if(MSVC) - if(VCPKG_TARGET_TRIPLET MATCHES "-static" AND NOT VCPKG_TARGET_TRIPLET MATCHES "-md") - # Switch to MT (static) instead of MD (dynamic) binary - - # For MSVC two generators are available - # - a command line generator (Ninja) using CMAKE_BUILD_TYPE to specify the - # configuration of the build tree - # - an IDE generator (Visual Studio) using CMAKE_CONFIGURATION_TYPES to - # specify all configurations that will be available in the generated solution - list(APPEND MSVC_CONFIGS "${CMAKE_BUILD_TYPE}" "${CMAKE_CONFIGURATION_TYPES}") - - # Set usage of static runtime for all configurations - foreach(MSVC_CONFIG ${MSVC_CONFIGS}) - string(TOUPPER "CMAKE_CXX_FLAGS_${MSVC_CONFIG}" MSVC_FLAGS) - string(REPLACE "/MD" "/MT" ${MSVC_FLAGS} "${${MSVC_FLAGS}}") - endforeach() - endif() - # "If /Zc:rvalueCast is specified, the compiler follows section 5.4 of the # C++11 standard". We need C++11 for the way we use threads. add_compile_options(/Zc:rvalueCast) @@ -33,6 +16,13 @@ macro(compile_flags) endif() endif() + # Our strings are UTF-8. + if(MSVC) + add_compile_options(/utf-8) + else() + add_compile_options(-finput-charset=utf-8) + endif() + # Add some -D flags for Debug builds. We cannot use add_definitions(), because # it does not appear to support the $<> tags. add_compile_options( @@ -55,9 +45,13 @@ macro(compile_flags) set(IS_STABLE_RELEASE "$>,$>>") if(MSVC) - add_compile_options(/W3) - if(MSVC_VERSION GREATER 1929 AND CMAKE_CXX_COMPILER_ID STREQUAL "MSVC") - # Starting with version 19.30, there is an optimisation bug, see #9966 for details + add_compile_options( + /W3 + /w34100 # 'identifier' : unreferenced formal parameter + /w34189 # 'identifier' : local variable is initialized but not referenced + ) + if(MSVC_VERSION GREATER 1929 AND MSVC_VERSION LESS 1937 AND CMAKE_CXX_COMPILER_ID STREQUAL "MSVC") + # Starting with version 19.30 (fixed in version 19.37), there is an optimisation bug, see #9966 for details # This flag disables the broken optimisation to work around the bug add_compile_options(/d2ssa-rse-) endif() @@ -76,9 +70,8 @@ macro(compile_flags) -Wformat=2 -Winit-self -Wnon-virtual-dtor + -Wsuggest-override - # Often parameters are unused, which is fine. - -Wno-unused-parameter # We use 'ABCD' multichar for SaveLoad chunks identifiers -Wno-multichar @@ -89,22 +82,6 @@ macro(compile_flags) -fno-strict-aliasing ) - # When we are a stable release (Release build + USE_ASSERTS not set), - # assertations are off, which trigger a lot of warnings. We disable - # these warnings for these releases. - if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU") - add_compile_options( - "$<${IS_STABLE_RELEASE}:-Wno-unused-variable>" - "$<${IS_STABLE_RELEASE}:-Wno-unused-but-set-parameter>" - "$<${IS_STABLE_RELEASE}:-Wno-unused-but-set-variable>" - ) - else() - add_compile_options( - "$<${IS_STABLE_RELEASE}:-Wno-unused-variable>" - "$<${IS_STABLE_RELEASE}:-Wno-unused-parameter>" - ) - endif() - # Ninja processes the output so the output from the compiler # isn't directly to a terminal; hence, the default is # non-coloured output. We can override this to get nicely diff --git a/cmake/CreateGrfCommand.cmake b/cmake/CreateGrfCommand.cmake index 107ec09b..02a7e8cd 100644 --- a/cmake/CreateGrfCommand.cmake +++ b/cmake/CreateGrfCommand.cmake @@ -1,16 +1,13 @@ # Macro which contains all bits and pieces to create a single grf file based # on NFO and PNG files. # -# create_grf_command() +# create_grf_command(NFO_SOURCE_FILES nfo_file1 ... PNG_SOURCE_FILES png_file1 ...) # function(create_grf_command) - set(EXTRA_PNG_SOURCE_FILES ${ARGV}) + cmake_parse_arguments(GRF "" "" "NFO_SOURCE_FILES;PNG_SOURCE_FILES" ${ARGN}) get_filename_component(GRF_SOURCE_FOLDER_NAME "${CMAKE_CURRENT_SOURCE_DIR}" NAME) get_filename_component(GRF_BINARY_FILE ${CMAKE_CURRENT_SOURCE_DIR}/../${GRF_SOURCE_FOLDER_NAME}.grf ABSOLUTE) - file(GLOB_RECURSE GRF_PNG_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.png) - file(GLOB_RECURSE GRF_NFO_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.nfo) - set(GRF_PNG_SOURCE_FILES ${GRF_PNG_SOURCE_FILES} ${EXTRA_PNG_SOURCE_FILES}) # Copy over all the PNG files to the correct folder foreach(GRF_PNG_SOURCE_FILE IN LISTS GRF_PNG_SOURCE_FILES) @@ -28,12 +25,13 @@ function(create_grf_command) list(APPEND GRF_PNG_BINARY_FILES ${GRF_PNG_BINARY_FILE}) endforeach() - add_custom_command(OUTPUT ${GRF_BINARY_FILE} + add_custom_command(OUTPUT ${GRF_BINARY_FILE} ${GRF_BINARY_FILE}.hash COMMAND ${CMAKE_COMMAND} -DGRF_SOURCE_FOLDER=${CMAKE_CURRENT_SOURCE_DIR} -DGRF_BINARY_FILE=${GRF_BINARY_FILE} -DNFORENUM_EXECUTABLE=${NFORENUM_EXECUTABLE} -DGRFCODEC_EXECUTABLE=${GRFCODEC_EXECUTABLE} + -DGRFID_EXECUTABLE=${GRFID_EXECUTABLE} -P ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateGRF.cmake DEPENDS ${GRF_PNG_BINARY_FILES} diff --git a/cmake/CreateRegression.cmake b/cmake/CreateRegression.cmake index 8e3865bc..355ced19 100644 --- a/cmake/CreateRegression.cmake +++ b/cmake/CreateRegression.cmake @@ -3,20 +3,15 @@ # 'ctest'. The first is prefered, as it is more verbose, and takes care of # dependencies correctly. # -# create_regression() +# create_regression(file1 ...) # macro(create_regression) - # Find all the files in the regression folder; they need to be copied to the - # build folder before we can run the regression - file(GLOB_RECURSE REGRESSION_SOURCE_FILES ${CMAKE_SOURCE_DIR}/regression/*) + set(REGRESSION_SOURCE_FILES ${ARGN}) + foreach(REGRESSION_SOURCE_FILE IN LISTS REGRESSION_SOURCE_FILES) string(REPLACE "${CMAKE_SOURCE_DIR}/regression/" "" REGRESSION_SOURCE_FILE_NAME "${REGRESSION_SOURCE_FILE}") string(CONCAT REGRESSION_BINARY_FILE "${CMAKE_BINARY_DIR}/ai/" "${REGRESSION_SOURCE_FILE_NAME}") - if("${REGRESSION_SOURCE_FILE_NAME}" STREQUAL "regression.cfg") - continue() - endif() - add_custom_command(OUTPUT ${REGRESSION_BINARY_FILE} COMMAND ${CMAKE_COMMAND} -E copy ${REGRESSION_SOURCE_FILE} @@ -28,59 +23,36 @@ macro(create_regression) list(APPEND REGRESSION_BINARY_FILES ${REGRESSION_BINARY_FILE}) endforeach() - # Copy the regression configuration in a special folder, so all autogenerated - # folders end up in the same place after running regression. - add_custom_command(OUTPUT ${CMAKE_BINARY_DIR}/regression/regression.cfg - COMMAND ${CMAKE_COMMAND} -E copy - ${CMAKE_SOURCE_DIR}/regression/regression.cfg - ${CMAKE_BINARY_DIR}/regression/regression.cfg - MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/regression/regression.cfg - COMMENT "Copying ${REGRESSION_SOURCE_FILE_NAME} regression file" - ) - list(APPEND REGRESSION_BINARY_FILES ${CMAKE_BINARY_DIR}/regression/regression.cfg) + get_filename_component(REGRESSION_TEST_NAME "${CMAKE_CURRENT_SOURCE_DIR}" NAME) - # Create a new target which copies all regression files - add_custom_target(regression_files - ALL # this is needed because 'make test' doesn't resolve dependencies, and otherwise this is never executed + # Create a new target which copies regression files + add_custom_target(regression_${REGRESSION_TEST_NAME}_files DEPENDS ${REGRESSION_BINARY_FILES} ) - enable_testing() - - # Find all the tests we have, and create a target for them - file(GLOB REGRESSION_TESTS ${CMAKE_SOURCE_DIR}/regression/*) - foreach(REGRESSION_TEST IN LISTS REGRESSION_TESTS) - get_filename_component(REGRESSION_TEST_NAME "${REGRESSION_TEST}" NAME) - - if("${REGRESSION_TEST_NAME}" STREQUAL "regression.cfg") - continue() - endif() - - add_custom_target(regression_${REGRESSION_TEST_NAME} - COMMAND ${CMAKE_COMMAND} - -DOPENTTD_EXECUTABLE=$ - -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE} - -DREGRESSION_TEST=${REGRESSION_TEST_NAME} - -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake" - DEPENDS openttd regression_files - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - COMMENT "Running regression test ${REGRESSION_TEST_NAME}" - ) - - # Also make sure that 'make test' runs the regression - add_test(NAME regression_${REGRESSION_TEST_NAME} - COMMAND ${CMAKE_COMMAND} - -DOPENTTD_EXECUTABLE=$ - -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE} - -DREGRESSION_TEST=${REGRESSION_TEST_NAME} - -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake" - WORKING_DIRECTORY ${CMAKE_BINARY_DIR}) + add_dependencies(regression_files regression_${REGRESSION_TEST_NAME}_files) + + add_custom_target(regression_${REGRESSION_TEST_NAME} + COMMAND ${CMAKE_COMMAND} + -DOPENTTD_EXECUTABLE=$ + -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE} + -DREGRESSION_TEST=${REGRESSION_TEST_NAME} + -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake" + DEPENDS openttd regression_${REGRESSION_TEST_NAME}_files + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Running regression test ${REGRESSION_TEST_NAME}" + ) - list(APPEND REGRESSION_TARGETS regression_${REGRESSION_TEST_NAME}) - endforeach() + # Also make sure that 'make test' runs the regression + add_test(NAME regression_${REGRESSION_TEST_NAME} + COMMAND ${CMAKE_COMMAND} + -DOPENTTD_EXECUTABLE=$ + -DEDITBIN_EXECUTABLE=${EDITBIN_EXECUTABLE} + -DREGRESSION_TEST=${REGRESSION_TEST_NAME} + -P "${CMAKE_SOURCE_DIR}/cmake/scripts/Regression.cmake" + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + ) - # Create a new target which runs the regression - add_custom_target(regression - DEPENDS ${REGRESSION_TARGETS}) + add_dependencies(regression regression_${REGRESSION_TEST_NAME}) endmacro() diff --git a/cmake/FindGrfcodec.cmake b/cmake/FindGrfcodec.cmake index 089f9567..d4d8d917 100644 --- a/cmake/FindGrfcodec.cmake +++ b/cmake/FindGrfcodec.cmake @@ -2,6 +2,7 @@ # find_program(GRFCODEC_EXECUTABLE grfcodec) +find_program(GRFID_EXECUTABLE grfid) find_program(NFORENUM_EXECUTABLE nforenum) include(FindPackageHandleStandardArgs) @@ -9,5 +10,6 @@ find_package_handle_standard_args(Grfcodec FOUND_VAR GRFCODEC_FOUND REQUIRED_VARS GRFCODEC_EXECUTABLE + GRFID_EXECUTABLE NFORENUM_EXECUTABLE ) diff --git a/cmake/FindHarfbuzz.cmake b/cmake/FindHarfbuzz.cmake new file mode 100644 index 00000000..11a4dcb3 --- /dev/null +++ b/cmake/FindHarfbuzz.cmake @@ -0,0 +1,65 @@ +#[=======================================================================[.rst: +FindHarfBuzz +------- + +Finds the harfbuzz library. + +Result Variables +^^^^^^^^^^^^^^^^ + +This will define the following variables: + +``Harfbuzz_FOUND`` + True if the system has the harfbuzz library. +``Harfbuzz_INCLUDE_DIRS`` + Include directories needed to use harfbuzz. +``Harfbuzz_LIBRARIES`` + Libraries needed to link to harfbuzz. +``Harfbuzz_VERSION`` + The version of the harfbuzz library which was found. + +Cache Variables +^^^^^^^^^^^^^^^ + +The following cache variables may also be set: + +``Harfbuzz_INCLUDE_DIR`` + The directory containing ``hb.h``. +``Harfbuzz_LIBRARY`` + The path to the harfbuzz library. + +#]=======================================================================] + +find_package(PkgConfig QUIET) +pkg_check_modules(PC_Harfbuzz QUIET harfbuzz) + +find_path(Harfbuzz_INCLUDE_DIR + NAMES hb.h + PATHS ${PC_Harfbuzz_INCLUDE_DIRS} +) + +find_library(Harfbuzz_LIBRARY + NAMES harfbuzz + PATHS ${PC_Harfbuzz_LIBRARY_DIRS} +) + +set(Harfbuzz_VERSION ${PC_Harfbuzz_VERSION}) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(Harfbuzz + FOUND_VAR Harfbuzz_FOUND + REQUIRED_VARS + Harfbuzz_LIBRARY + Harfbuzz_INCLUDE_DIR + VERSION_VAR Harfbuzz_VERSION +) + +if(Harfbuzz_FOUND) + set(Harfbuzz_LIBRARIES ${Harfbuzz_LIBRARY}) + set(Harfbuzz_INCLUDE_DIRS ${Harfbuzz_INCLUDE_DIR}) +endif() + +mark_as_advanced( + Harfbuzz_INCLUDE_DIR + Harfbuzz_LIBRARY +) diff --git a/cmake/FindICU.cmake b/cmake/FindICU.cmake index d12f36b0..efb3ba3a 100644 --- a/cmake/FindICU.cmake +++ b/cmake/FindICU.cmake @@ -9,7 +9,7 @@ FindICU Finds components of the ICU library. -Accepted components are: uc, i18n, le, lx, io +Accepted components are: uc, i18n, le, lx, io, data Result Variables ^^^^^^^^^^^^^^^^ @@ -31,7 +31,7 @@ This will define the following variables: find_package(PkgConfig QUIET) -set(ICU_KNOWN_COMPONENTS "uc" "i18n" "le" "lx" "io") +set(ICU_KNOWN_COMPONENTS "uc" "i18n" "le" "lx" "io" "data") foreach(MOD_NAME IN LISTS ICU_FIND_COMPONENTS) if(NOT MOD_NAME IN_LIST ICU_KNOWN_COMPONENTS) diff --git a/cmake/FindLZO.cmake b/cmake/FindLZO.cmake index dacd9387..20ea4c1b 100644 --- a/cmake/FindLZO.cmake +++ b/cmake/FindLZO.cmake @@ -55,7 +55,7 @@ find_library(LZO_LIBRARY # name as the optimized file. This is not always the case, but so far # experiences has shown that in those case vcpkg CMake files do the right # thing. -if(VCPKG_TOOLCHAIN AND LZO_LIBRARY) +if(VCPKG_TOOLCHAIN AND LZO_LIBRARY AND LZO_LIBRARY MATCHES "${VCPKG_INSTALLED_DIR}") if(LZO_LIBRARY MATCHES "/debug/") set(LZO_LIBRARY_DEBUG ${LZO_LIBRARY}) string(REPLACE "/debug/lib/" "/lib/" LZO_LIBRARY_RELEASE ${LZO_LIBRARY}) diff --git a/cmake/InstallAndPackage.cmake b/cmake/InstallAndPackage.cmake index be37b9b7..9c9071fd 100644 --- a/cmake/InstallAndPackage.cmake +++ b/cmake/InstallAndPackage.cmake @@ -23,26 +23,57 @@ install(TARGETS openttd COMPONENT Runtime ) -install(DIRECTORY - ${CMAKE_BINARY_DIR}/lang - ${CMAKE_BINARY_DIR}/baseset - ${CMAKE_BINARY_DIR}/ai - ${CMAKE_BINARY_DIR}/game - ${CMAKE_SOURCE_DIR}/bin/scripts - DESTINATION ${DATA_DESTINATION_DIR} - COMPONENT language_files - REGEX "ai/[^\.]+$" EXCLUDE # Ignore subdirs in ai dir -) +if (NOT EMSCRIPTEN) + # Emscripten embeds these files in openttd.data. + # See CMakeLists.txt in the root. + install(DIRECTORY + ${CMAKE_BINARY_DIR}/lang + ${CMAKE_BINARY_DIR}/baseset + ${CMAKE_BINARY_DIR}/ai + ${CMAKE_BINARY_DIR}/game + ${CMAKE_SOURCE_DIR}/bin/scripts + DESTINATION ${DATA_DESTINATION_DIR} + COMPONENT language_files + REGEX "ai/[^\.]+$" EXCLUDE # Ignore subdirs in ai dir + ) +else() + install(FILES + ${CMAKE_BINARY_DIR}/openttd.js + ${CMAKE_BINARY_DIR}/openttd.wasm + ${CMAKE_BINARY_DIR}/openttd.data + DESTINATION ${BINARY_DESTINATION_DIR} + COMPONENT Runtime + ) +endif() install(FILES ${CMAKE_SOURCE_DIR}/COPYING.md ${CMAKE_SOURCE_DIR}/README.md + ${CMAKE_SOURCE_DIR}/CREDITS.md + ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md ${CMAKE_SOURCE_DIR}/changelog.txt - ${CMAKE_SOURCE_DIR}/docs/multiplayer.md ${CMAKE_SOURCE_DIR}/known-bugs.txt DESTINATION ${DOCS_DESTINATION_DIR} COMPONENT docs) +install(FILES + ${CMAKE_SOURCE_DIR}/docs/admin_network.md + ${CMAKE_SOURCE_DIR}/docs/debugging_desyncs.md + ${CMAKE_SOURCE_DIR}/docs/desync.md + ${CMAKE_SOURCE_DIR}/docs/directory_structure.md + ${CMAKE_SOURCE_DIR}/docs/eints.md + ${CMAKE_SOURCE_DIR}/docs/game_coordinator.md + ${CMAKE_SOURCE_DIR}/docs/linkgraph.md + ${CMAKE_SOURCE_DIR}/docs/logging_and_performance_metrics.md + ${CMAKE_SOURCE_DIR}/docs/multiplayer.md + ${CMAKE_SOURCE_DIR}/docs/savegame_format.md + ${CMAKE_SOURCE_DIR}/docs/symbol_server.md + ${CMAKE_SOURCE_DIR}/docs/obg_format.txt + ${CMAKE_SOURCE_DIR}/docs/obm_format.txt + ${CMAKE_SOURCE_DIR}/docs/obs_format.txt + DESTINATION ${DOCS_DESTINATION_DIR}/docs + COMPONENT docs) + # A Linux manual only makes sense when using FHS. Otherwise it is a very odd # file with little context to what it is. if(OPTION_INSTALL_FHS) @@ -60,7 +91,7 @@ if(OPTION_INSTALL_FHS) COMPONENT manual) endif() -if(UNIX AND NOT APPLE) +if(UNIX AND NOT APPLE AND NOT EMSCRIPTEN) install(DIRECTORY ${CMAKE_BINARY_DIR}/media/icons ${CMAKE_BINARY_DIR}/media/pixmaps @@ -164,7 +195,7 @@ elseif(UNIX) OUTPUT_STRIP_TRAILING_WHITESPACE ) if(LSB_RELEASE_ID) - if(LSB_RELEASE_ID STREQUAL "Ubuntu" OR LSB_RELEASE_ID STREQUAL "Debian") + if(LSB_RELEASE_ID STREQUAL "Ubuntu" OR LSB_RELEASE_ID STREQUAL "Debian" OR LSB_RELEASE_ID STREQUAL "Linuxmint") execute_process(COMMAND ${LSB_RELEASE_EXEC} -cs OUTPUT_VARIABLE LSB_RELEASE_CODENAME OUTPUT_STRIP_TRAILING_WHITESPACE @@ -173,6 +204,10 @@ elseif(UNIX) set(CPACK_GENERATOR "DEB") include(PackageDeb) + elseif(LSB_RELEASE_ID STREQUAL "Fedora") + set(PLATFORM "fedora") + set(CPACK_GENERATOR "RPM") + include(PackageRPM) else() set(UNSUPPORTED_PLATFORM_NAME "LSB-based Linux distribution '${LSB_RELEASE_ID}'") endif() diff --git a/cmake/LinkPackage.cmake b/cmake/LinkPackage.cmake index bea9deb0..9fb2cf59 100644 --- a/cmake/LinkPackage.cmake +++ b/cmake/LinkPackage.cmake @@ -3,18 +3,21 @@ function(link_package NAME) if(${NAME}_FOUND) string(TOUPPER "${NAME}" UCNAME) + # Some libraries have a dash, which is not allowed in a preprocessor macro. + string(REPLACE "-" "_" UCNAME "${UCNAME}") + add_definitions(-DWITH_${UCNAME}) # Some libraries' cmake packages (looking at you, SDL2) leave trailing whitespace in the link commands, # which (later) cmake considers to be an error. Work around this with by stripping the incoming string. if(LP_TARGET AND TARGET ${LP_TARGET}) string(STRIP "${LP_TARGET}" LP_TARGET) - target_link_libraries(openttd ${LP_TARGET}) + target_link_libraries(openttd_lib ${LP_TARGET}) message(STATUS "${NAME} found -- -DWITH_${UCNAME} -- ${LP_TARGET}") else() string(STRIP "${${NAME}_LIBRARY}" ${NAME}_LIBRARY) string(STRIP "${${NAME}_LIBRARIES}" ${NAME}_LIBRARIES) include_directories(${${NAME}_INCLUDE_DIRS} ${${NAME}_INCLUDE_DIR}) - target_link_libraries(openttd ${${NAME}_LIBRARIES} ${${NAME}_LIBRARY}) + target_link_libraries(openttd_lib ${${NAME}_LIBRARIES} ${${NAME}_LIBRARY}) message(STATUS "${NAME} found -- -DWITH_${UCNAME} -- ${${NAME}_INCLUDE_DIRS} ${${NAME}_INCLUDE_DIR} -- ${${NAME}_LIBRARIES} ${${NAME}_LIBRARY}") endif() elseif(LP_ENCOURAGED) diff --git a/cmake/Options.cmake b/cmake/Options.cmake index bfa14b6c..3c8692fe 100644 --- a/cmake/Options.cmake +++ b/cmake/Options.cmake @@ -56,7 +56,7 @@ function(set_options) option(OPTION_DEDICATED "Build dedicated server only (no GUI)" OFF) option(OPTION_INSTALL_FHS "Install with Filesystem Hierarchy Standard folders" ${DEFAULT_OPTION_INSTALL_FHS}) - option(OPTION_USE_ASSERTS "Use assertions; leave enabled for nightlies, betas, and RCs" OFF) + option(OPTION_USE_ASSERTS "Use assertions; leave enabled for nightlies, betas, and RCs" ON) if(EMSCRIPTEN) # Although pthreads is supported, it is not in a way yet that is # useful for us. @@ -67,10 +67,13 @@ function(set_options) option(OPTION_USE_NSIS "Use NSIS to create windows installer; enable only for stable releases" OFF) option(OPTION_TOOLS_ONLY "Build only tools target" OFF) option(OPTION_DOCS_ONLY "Build only docs target" OFF) + option(OPTION_ALLOW_INVALID_SIGNATURE "Allow loading of content with invalid signatures" OFF) if (OPTION_DOCS_ONLY) set(OPTION_TOOLS_ONLY ON PARENT_SCOPE) endif() + + option(OPTION_SURVEY_KEY "Survey-key to use for the opt-in survey (empty if you have none)" "") endfunction() # Show the values of the generic options. @@ -84,6 +87,17 @@ function(show_options) message(STATUS "Option Use assert - ${OPTION_USE_ASSERTS}") message(STATUS "Option Use threads - ${OPTION_USE_THREADS}") message(STATUS "Option Use NSIS - ${OPTION_USE_NSIS}") + + if(OPTION_SURVEY_KEY) + message(STATUS "Option Survey Key - USED") + else() + message(STATUS "Option Survey Key - NOT USED") + endif() + + if(OPTION_ALLOW_INVALID_SIGNATURE) + message(STATUS "Option Allow Invalid Signature - USED") + message(WARNING "Ignoring invalid signatures is a security risk! Use with care!") + endif() endfunction() # Add the definitions for the options that are selected. @@ -104,4 +118,12 @@ function(add_definitions_based_on_options) else() add_definitions(-DNDEBUG) endif() + + if(OPTION_SURVEY_KEY) + add_definitions(-DSURVEY_KEY="${OPTION_SURVEY_KEY}") + endif() + + if(OPTION_ALLOW_INVALID_SIGNATURE) + add_definitions(-DALLOW_INVALID_SIGNATURE) + endif() endfunction() diff --git a/cmake/SourceList.cmake b/cmake/SourceList.cmake index 6e95be20..f01f5db8 100644 --- a/cmake/SourceList.cmake +++ b/cmake/SourceList.cmake @@ -1,12 +1,4 @@ -# Add a file to be compiled. -# -# add_files([file1 ...] CONDITION condition [condition ...]) -# -# CONDITION is a complete statement that can be evaluated with if(). -# If it evaluates true, the source files will be added; otherwise not. -# For example: ADD_IF SDL_FOUND AND Allegro_FOUND -# -function(add_files) +function(_add_files_tgt tgt) cmake_parse_arguments(PARAM "" "" "CONDITION" ${ARGN}) set(PARAM_FILES "${PARAM_UNPARSED_ARGUMENTS}") @@ -17,10 +9,44 @@ function(add_files) endif() foreach(FILE IN LISTS PARAM_FILES) - target_sources(openttd PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/${FILE}) + # Some IDEs are not happy with duplicated filenames, so we detect that before adding the file. + get_target_property(${tgt}_FILES ${tgt} SOURCES) + if(${tgt}_FILES MATCHES "/${FILE}(;|$)") + string(REGEX REPLACE "(^|.+;)([^;]+/${FILE})(;.+|$)" "\\2" RES "${${tgt}_FILES}") + # Ignore header files duplicates in 3rdparty. + if(NOT (${FILE} MATCHES "\.h" AND (${RES} MATCHES "3rdparty" OR ${CMAKE_CURRENT_SOURCE_DIR} MATCHES "3rdparty"))) + message(FATAL_ERROR "${tgt}: ${CMAKE_CURRENT_SOURCE_DIR}/${FILE} filename is a duplicate of ${RES}") + endif() + endif() + + target_sources(${tgt} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/${FILE}) endforeach() endfunction() +# Add a file to be compiled. +# +# add_files([file1 ...] CONDITION condition [condition ...]) +# +# CONDITION is a complete statement that can be evaluated with if(). +# If it evaluates true, the source files will be added; otherwise not. +# For example: ADD_IF SDL_FOUND AND Allegro_FOUND +# +function(add_files) + _add_files_tgt(openttd_lib ${ARGV}) +endfunction() + +# Add a test file to be compiled. +# +# add_test_files([file1 ...] CONDITION condition [condition ...]) +# +# CONDITION is a complete statement that can be evaluated with if(). +# If it evaluates true, the source files will be added; otherwise not. +# For example: ADD_IF SDL_FOUND AND Allegro_FOUND +# +function(add_test_files) + _add_files_tgt(openttd_test ${ARGV}) +endfunction() + # This function works around an 'issue' with CMake, where # set_source_files_properties() only works in the scope of the file. We want # to set properties for the source file on a more global level. To solve this, diff --git a/cmake/scripts/Baseset.cmake b/cmake/scripts/Baseset.cmake index cb5fb570..c298aea4 100644 --- a/cmake/scripts/Baseset.cmake +++ b/cmake/scripts/Baseset.cmake @@ -58,6 +58,7 @@ list(SORT ${PLACE_HOLDER}) string(REPLACE ";" "\n" ${PLACE_HOLDER} "${${PLACE_HOLDER}}") # Get the grf md5 -file(MD5 ${BASESET_EXTRAGRF_FILE} ORIG_EXTRA_GRF_MD5) +file(READ ${BASESET_EXTRAGRF_FILE}.hash ORIG_EXTRA_GRF_MD5) +string(STRIP ${ORIG_EXTRA_GRF_MD5} ORIG_EXTRA_GRF_MD5) configure_file(${BASESET_SOURCE_FILE} ${BASESET_BINARY_FILE}) diff --git a/cmake/scripts/CreateGRF.cmake b/cmake/scripts/CreateGRF.cmake index d47e39aa..eff9a7b9 100644 --- a/cmake/scripts/CreateGRF.cmake +++ b/cmake/scripts/CreateGRF.cmake @@ -11,6 +11,9 @@ endif() if(NOT GRFCODEC_EXECUTABLE) message(FATAL_ERROR "Script needs GRFCODEC_EXECUTABLE defined") endif() +if(NOT GRFID_EXECUTABLE) + message(FATAL_ERROR "Script needs GRFID_EXECUTABLE defined") +endif() if(NOT GRF_SOURCE_FOLDER) message(FATAL_ERROR "Script needs GRF_SOURCE_FOLDER defined") endif() @@ -18,6 +21,9 @@ if(NOT GRF_BINARY_FILE) message(FATAL_ERROR "Script needs GRF_BINARY_FILE defined") endif() +# Remove the existing output so failures never go unnoticed +file(REMOVE ${GRF_BINARY_FILE} ${GRF_BINARY_FILE}.hash) + get_filename_component(GRF_SOURCE_FOLDER_NAME "${GRF_SOURCE_FOLDER}" NAME) file(WRITE sprites/${GRF_SOURCE_FOLDER_NAME}.nfo "") @@ -47,7 +53,7 @@ if(RESULT) message(FATAL_ERROR "NFORenum failed") endif() -execute_process(COMMAND ${GRFCODEC_EXECUTABLE} -n -s -e -p1 ${GRF_SOURCE_FOLDER_NAME}.grf RESULT_VARIABLE RESULT) +execute_process(COMMAND ${GRFCODEC_EXECUTABLE} -n -s -e -g2 -p1 ${GRF_SOURCE_FOLDER_NAME}.grf RESULT_VARIABLE RESULT) if(RESULT) if(NOT RESULT MATCHES "^[0-9]*$") message(FATAL_ERROR "Failed to run GRFCodec (${RESULT}), please check GRFCODEC_EXECUTABLE variable") @@ -55,4 +61,15 @@ if(RESULT) message(FATAL_ERROR "GRFCodec failed") endif() +execute_process(COMMAND ${GRFID_EXECUTABLE} -m ${GRF_SOURCE_FOLDER_NAME}.grf OUTPUT_VARIABLE GRFID_HASH RESULT_VARIABLE RESULT) +if(RESULT) + if(NOT RESULT MATCHES "^[0-9]*$") + message(FATAL_ERROR "Failed to run GRFID (${RESULT}), please check GRFID_EXECUTABLE variable") + endif() + message(FATAL_ERROR "GRFID failed") +endif() + +file(WRITE ${GRF_BINARY_FILE}.hash ${GRFID_HASH}) + +# Copy build files back to the source directory. execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${GRF_SOURCE_FOLDER_NAME}.grf ${GRF_BINARY_FILE}) diff --git a/cmake/scripts/Regression.cmake b/cmake/scripts/Regression.cmake index 19fece83..af547179 100644 --- a/cmake/scripts/Regression.cmake +++ b/cmake/scripts/Regression.cmake @@ -34,7 +34,6 @@ execute_process(COMMAND ${OPENTTD_EXECUTABLE} -mnull -vnull:ticks=30000 -d script=2 - -d misc=9 -Q OUTPUT_VARIABLE REGRESSION_OUTPUT ERROR_VARIABLE REGRESSION_RESULT @@ -54,16 +53,28 @@ string(REPLACE "0x(nil)" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}") string(REPLACE "0x0000000000000000" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}") string(REPLACE "0x0x0" "0x00000000" REGRESSION_RESULT "${REGRESSION_RESULT}") +# Convert path separators +string(REPLACE "\\" "/" REGRESSION_RESULT "${REGRESSION_RESULT}") + # Remove timestamps if any -string(REGEX REPLACE "\[[0-9-]+ [0-9:]+\] " "" REGRESSION_RESULT "${REGRESSION_RESULT}") +string(REGEX REPLACE "\\\[[0-9-]+ [0-9:]+\\\] " "" REGRESSION_RESULT "${REGRESSION_RESULT}") + +# Remove log level +string(REGEX REPLACE "\\\[script:[0-9]\\\]" "" REGRESSION_RESULT "${REGRESSION_RESULT}") # Convert the output to a format that is expected (and more readable) by result.txt -string(REPLACE "\ndbg: [script]" "\n" REGRESSION_RESULT "${REGRESSION_RESULT}") +string(REPLACE "\ndbg: " "\n" REGRESSION_RESULT "${REGRESSION_RESULT}") string(REPLACE "\n " "\nERROR: " REGRESSION_RESULT "${REGRESSION_RESULT}") string(REPLACE "\nERROR: [1] " "\n" REGRESSION_RESULT "${REGRESSION_RESULT}") string(REPLACE "\n[P] " "\n" REGRESSION_RESULT "${REGRESSION_RESULT}") +string(REPLACE "\n[S] " "\n" REGRESSION_RESULT "${REGRESSION_RESULT}") string(REGEX REPLACE "dbg: ([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}") +# Remove duplicate script info +string(REGEX REPLACE "ERROR: Registering([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}") +string(REGEX REPLACE "ERROR: [12]([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}") +string(REGEX REPLACE "ERROR: The first([^\n]*)\n?" "" REGRESSION_RESULT "${REGRESSION_RESULT}") + # Read the expected result file(READ ai/${REGRESSION_TEST}/result.txt REGRESSION_EXPECTED) @@ -87,7 +98,7 @@ foreach(RESULT IN LISTS REGRESSION_RESULT) if(NOT RESULT STREQUAL EXPECTED) message("${ARGC}: - ${EXPECTED}") - message("${ARGC}: + ${RESULT}'") + message("${ARGC}: + ${RESULT}") set(ERROR YES) endif() endforeach() diff --git a/cmake/scripts/SquirrelExport.cmake b/cmake/scripts/SquirrelExport.cmake index c1305066..5116a4c9 100644 --- a/cmake/scripts/SquirrelExport.cmake +++ b/cmake/scripts/SquirrelExport.cmake @@ -28,25 +28,27 @@ endmacro() macro(dump_class_templates NAME) string(REGEX REPLACE "^Script" "" REALNAME ${NAME}) - string(APPEND SQUIRREL_EXPORT "\n template <> inline ${NAME} *GetParam(ForceType<${NAME} *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return (${NAME} *)instance; }") - string(APPEND SQUIRREL_EXPORT "\n template <> inline ${NAME} &GetParam(ForceType<${NAME} &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; }") - string(APPEND SQUIRREL_EXPORT "\n template <> inline const ${NAME} *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return (${NAME} *)instance; }") - string(APPEND SQUIRREL_EXPORT "\n template <> inline const ${NAME} &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; }") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Param<${NAME} *> { static inline ${NAME} *Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return (${NAME} *)instance; } };") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Param<${NAME} &> { static inline ${NAME} &Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; } };") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Param { static inline const ${NAME} *Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return (${NAME} *)instance; } };") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Param { static inline const ${NAME} &Get(HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, nullptr); return *(${NAME} *)instance; } };") if("${NAME}" STREQUAL "ScriptEvent") - string(APPEND SQUIRREL_EXPORT "\n template <> inline int Return<${NAME} *>(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; }") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Return<${NAME} *> { static inline int Set(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; } };") elseif("${NAME}" STREQUAL "ScriptText") string(APPEND SQUIRREL_EXPORT "\n") - string(APPEND SQUIRREL_EXPORT "\n template <> inline Text *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) {") - string(APPEND SQUIRREL_EXPORT "\n if (sq_gettype(vm, index) == OT_INSTANCE) {") - string(APPEND SQUIRREL_EXPORT "\n return GetParam(ForceType(), vm, index, ptr);") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Param {") + string(APPEND SQUIRREL_EXPORT "\n static inline Text *Get(HSQUIRRELVM vm, int index) {") + string(APPEND SQUIRREL_EXPORT "\n if (sq_gettype(vm, index) == OT_INSTANCE) {") + string(APPEND SQUIRREL_EXPORT "\n return Param::Get(vm, index);") + string(APPEND SQUIRREL_EXPORT "\n }") + string(APPEND SQUIRREL_EXPORT "\n if (sq_gettype(vm, index) == OT_STRING) {") + string(APPEND SQUIRREL_EXPORT "\n return new RawText(Param::Get(vm, index));") + string(APPEND SQUIRREL_EXPORT "\n }") + string(APPEND SQUIRREL_EXPORT "\n return nullptr;") string(APPEND SQUIRREL_EXPORT "\n }") - string(APPEND SQUIRREL_EXPORT "\n if (sq_gettype(vm, index) == OT_STRING) {") - string(APPEND SQUIRREL_EXPORT "\n return new RawText(GetParam(ForceType(), vm, index, ptr));") - string(APPEND SQUIRREL_EXPORT "\n }") - string(APPEND SQUIRREL_EXPORT "\n return nullptr;") - string(APPEND SQUIRREL_EXPORT "\n }") + string(APPEND SQUIRREL_EXPORT "\n };") else() - string(APPEND SQUIRREL_EXPORT "\n template <> inline int Return<${NAME} *>(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; }") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Return<${NAME} *> { static inline int Set(HSQUIRRELVM vm, ${NAME} *res) { if (res == nullptr) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, \"${REALNAME}\", res, nullptr, DefSQDestructorCallback<${NAME}>, true); return 1; } };") endif() endmacro() @@ -69,13 +71,23 @@ reset_reader() file(STRINGS "${SCRIPT_API_FILE}" SOURCE_LINES) +set(NUM_LINE 0) +macro(doxygen_check) + if(NOT "${DOXYGEN_SKIP}" STREQUAL "") + message(FATAL_ERROR "${SCRIPT_API_FILE}:${NUM_LINE}: a DOXYGEN_API block was not properly closed") + endif() +endmacro() + foreach(LINE IN LISTS SOURCE_LINES) + math(EXPR NUM_LINE "${NUM_LINE} + 1") # Ignore special doxygen blocks if("${LINE}" MATCHES "^#ifndef DOXYGEN_API") + doxygen_check() set(DOXYGEN_SKIP "next") continue() endif() if("${LINE}" MATCHES "^#ifdef DOXYGEN_API") + doxygen_check() set(DOXYGEN_SKIP "true") continue() endif() @@ -84,10 +96,10 @@ foreach(LINE IN LISTS SOURCE_LINES) continue() endif() if("${LINE}" MATCHES "^#else") - if("${DOXYGEN_SKIP}" STREQUAL "next") + if(DOXYGEN_SKIP STREQUAL "next") set(DOXYGEN_SKIP "true") - else() - unset(DOXYGEN_SKIP) + elseif(DOXYGEN_SKIP STREQUAL "true") + set(DOXYGEN_SKIP "false") endif() continue() endif() @@ -297,8 +309,8 @@ foreach(LINE IN LISTS SOURCE_LINES) endif() string(APPEND SQUIRREL_EXPORT "\n /* Allow enums to be used as Squirrel parameters */") foreach(ENUM IN LISTS ENUMS) - string(APPEND SQUIRREL_EXPORT "\n template <> inline ${ENUM} GetParam(ForceType<${ENUM}>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (${ENUM})tmp; }") - string(APPEND SQUIRREL_EXPORT "\n template <> inline int Return<${ENUM}>(HSQUIRRELVM vm, ${ENUM} res) { sq_pushinteger(vm, (int32)res); return 1; }") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Param<${ENUM}> { static inline ${ENUM} Get(HSQUIRRELVM vm, int index) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (${ENUM})tmp; } };") + string(APPEND SQUIRREL_EXPORT "\n template <> struct Return<${ENUM}> { static inline int Set(HSQUIRRELVM vm, ${ENUM} res) { sq_pushinteger(vm, res); return 1; } };") endforeach() endif() @@ -330,13 +342,13 @@ foreach(LINE IN LISTS SOURCE_LINES) endif() string(APPEND SQUIRREL_EXPORT "\n") - string(APPEND SQUIRREL_EXPORT "\ntemplate <> const char *GetClassName<${CLS}, ST_${APIUC}>() { return \"${API_CLS}\"; }") + string(APPEND SQUIRREL_EXPORT "\ntemplate <> const char *GetClassName<${CLS}, ScriptType::${APIUC}>() { return \"${API_CLS}\"; }") string(APPEND SQUIRREL_EXPORT "\n") # Then do the registration functions of the class. string(APPEND SQUIRREL_EXPORT "\nvoid SQ${API_CLS}_Register(Squirrel *engine)") string(APPEND SQUIRREL_EXPORT "\n{") - string(APPEND SQUIRREL_EXPORT "\n DefSQClass<${CLS}, ST_${APIUC}> SQ${API_CLS}(\"${API_CLS}\");") + string(APPEND SQUIRREL_EXPORT "\n DefSQClass<${CLS}, ScriptType::${APIUC}> SQ${API_CLS}(\"${API_CLS}\");") if("${SUPER_CLS}" STREQUAL "Text" OR "${SUPER_CLS}" STREQUAL "ScriptObject" OR "${SUPER_CLS}" STREQUAL "AIAbstractiveList::Valuator") string(APPEND SQUIRREL_EXPORT "\n SQ${API_CLS}.PreRegister(engine);") else() @@ -625,10 +637,12 @@ foreach(LINE IN LISTS SOURCE_LINES) string(APPEND TYPES "p") elseif("${PARAM}" MATCHES "^Array") string(APPEND TYPES "a") - elseif("${PARAM}" MATCHES "^struct Array") + elseif("${PARAM}" MATCHES "^const Array") string(APPEND TYPES "a") elseif("${PARAM}" MATCHES "^Text") string(APPEND TYPES ".") + elseif("${PARAM}" MATCHES "^std::string") + string(APPEND TYPES ".") else() string(APPEND TYPES "x") endif() @@ -664,4 +678,6 @@ foreach(LINE IN LISTS SOURCE_LINES) endif() endforeach() +doxygen_check() + configure_file(${SCRIPT_API_SOURCE_FILE} ${SCRIPT_API_BINARY_FILE}) diff --git a/docs/debugging_desyncs.md b/docs/debugging_desyncs.md index f5ea06e0..0b6aacde 100644 --- a/docs/debugging_desyncs.md +++ b/docs/debugging_desyncs.md @@ -53,4 +53,7 @@ Do NOT remove the dmp_cmds savegames of a desync you have reported until the desync has been fixed; if you, by accident, send us the wrong savegames we will not be able to reproduce the desync and thus will be unable to fix it. +## More information +You can find more theory on the causes and debugging of desyncs in the +[desync documentation](./desync.md). diff --git a/docs/directory_structure.md b/docs/directory_structure.md index 51ad1c5a..72a62eee 100644 --- a/docs/directory_structure.md +++ b/docs/directory_structure.md @@ -19,14 +19,14 @@ your operating system: - Windows: - `C:\My Documents\OpenTTD` (95, 98, ME) - `C:\Documents and Settings\\My Documents\OpenTTD` (2000, XP) - - `C:\Users\\Documents\OpenTTD` (Vista, 7, 8.1, 10) + - `C:\Users\\Documents\OpenTTD` (7, 8.1, 10, 11) - macOS: `~/Documents/OpenTTD` - Linux: `$XDG_DATA_HOME/openttd` which is usually `~/.local/share/openttd` when built with XDG base directory support, otherwise `~/.openttd` 3. The shared directory - Windows: - `C:\Documents and Settings\All Users\Shared Documents\OpenTTD` (2000, XP) - - `C:\Users\Public\Documents\OpenTTD` (Vista, 7, 8.1, 10) + - `C:\Users\Public\Documents\OpenTTD` (7, 8.1, 10, 11) - macOS: `/Library/Application Support/OpenTTD` - Linux: not available 4. The binary directory (where the OpenTTD executable is) diff --git a/docs/eints.md b/docs/eints.md index 1fbdbf1d..0e49d56a 100644 --- a/docs/eints.md +++ b/docs/eints.md @@ -25,6 +25,10 @@ The translators will decide whether, where and how to apply your suggestion. Sorry, we don't offer this option. +Only when there is a consistency problem that needs addressing, this can be done via a PR. +We are very strict about this, and in general all PRs making translation changes will be closed. +But if it is really needed, and the change is not a revert of any older change, a PR can be created to do mass changes to a translation. + ### I want to change the language definition (plural form, genders, cases) of a translation. Please [create an issue](https://github.com/OpenTTD/OpenTTD/issues/new/choose) for this. diff --git a/docs/landscape.html b/docs/landscape.html index ab4ad989..f592cd0f 100644 --- a/docs/landscape.html +++ b/docs/landscape.html @@ -807,8 +807,6 @@

Landscape

  • m2 bits 5..4: ground density
  • -
  • m2 bits 3..0: update counter, incremented on every periodic processing.
    - on wraparound the growth status is updated (or, if it's 3, a random action is taken)
  • m3 bits 7..0: type of trees: @@ -991,13 +989,17 @@

    Landscape

  • +
  • m6 bit 7: rail station / waypoint may have catenary pylons
  • +
  • m6 bit 6: rail station / waypoint may have catenary wires
  • m6 bits 5..3: the station type (rail, airport, truck, bus, oilrig, dock, buoy, waypoint)
  • m6 bit 2: pbs reservation state for railway stations/waypoints
  • +
  • m6 bit 0: rail station / waypoint is blocked
  • m7 bits 4..0: owner of road (road stops)
  • m7: animation frame (railway stations/waypoints, airports)
  • m8 bits 11..6: Tramtype
  • m8 bits 5..0: track type for railway stations/waypoints
  • +
  • m8 bits 5..0: custom road stop id; 0 means standard graphics
  • diff --git a/docs/landscape_grid.html b/docs/landscape_grid.html index fc0c6e0c..a0fa527a 100644 --- a/docs/landscape_grid.html +++ b/docs/landscape_grid.html @@ -188,7 +188,7 @@

    Landscape

    XXXX OOOO XXXX XXXX XXXX XXXX - OOXXX XOO + XXXXX XOX XXXX XXXX OOOO OOOO OOXX XXXX @@ -203,7 +203,7 @@

    Landscape

    OOOO OXXX OOXX XOOO OOOX XXXX - OOOO XXXX XXOO OOOO + OOOO XXXX XX XXXXXX airport diff --git a/docs/multiplayer.md b/docs/multiplayer.md index 6ef14c4e..15aaa68e 100644 --- a/docs/multiplayer.md +++ b/docs/multiplayer.md @@ -193,6 +193,9 @@ If it is, and your server still isn't showing up, start OpenTTD with `-d net=4` as extra argument. This will show debug message related to the network, including communication to/from the Game Coordinator. +See the [Game Coordinator documentation](./game_coordinator.md) for more +technical information about the Game Coordinator service. + ### My server warns a lot about getaddrinfo taking N seconds This could be a transient issue with your (local) DNS server, but if the diff --git a/docs/openttd.6 b/docs/openttd.6 index 4e04be32..0319f98c 100644 --- a/docs/openttd.6 +++ b/docs/openttd.6 @@ -1,6 +1,6 @@ .\" Hey, EMACS: -*- nroff -*- .\" Please adjust this date whenever revising the manpage. -.Dd October 13, 2014 +.Dd August 12, 2023 .Dt OPENTTD 6 .Os .Sh NAME @@ -8,18 +8,17 @@ .Nd open source clone of the Microprose game \(lqTransport Tycoon Deluxe\(rq .Sh SYNOPSIS .Nm -.Op Fl efhx +.Op Fl efhQxX .Op Fl b Ar blitter .Op Fl c Ar config_file .Op Fl d Op Ar level | Ar cat Ns = Ns Ar lvl Ns Op , Ns Ar ... .Op Fl D Oo Ar host Oc Ns Op : Ns Ar port -.Op Fl g Op Ar savegame +.Op Fl g Op Ar file .Op Fl G Ar seed .Op Fl I Ar graphicsset -.Op Fl l Ar host Ns Op : Ns Ar port .Op Fl m Ar driver .Op Fl M Ar musicset -.Op Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player +.Op Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar company .Op Fl p Ar password .Op Fl P Ar password .Op Fl q Ar savegame @@ -29,7 +28,7 @@ .Op Fl t Ar year .Op Fl v Ar driver .Sh OPTIONS -.Bl -tag -width "-n host[:port][#player]" +.Bl -tag -width "-n host[:port][#company]" .It Fl b Ar blitter Select the blitter .Ar blitter ; @@ -63,11 +62,11 @@ Start in world editor mode. .It Fl f Fork into background (dedicated server only, see .Fl D ) . -.It Fl g Op Ar savegame +.It Fl g Op Ar file Load -.Ar savegame -at start or start a new game if omitted. -.Ar savegame +.Ar file +(can be either a savegame, scenario, or heightmap) at start or start a new game if omitted. +.Ar file must be either an absolute path or one relative to the current path or one of the search paths. .It Fl G Ar seed @@ -82,11 +81,6 @@ Select the graphics set see .Fl h for a full list. -.It Fl l Ar host Ns Op : Ns Ar port -Redirect -.Fn DEBUG -output; see -.Fl D . .It Fl m Ar driver Select the music driver .Ar driver ; @@ -99,8 +93,8 @@ Select the music set see .Fl h for a full list. -.It Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar player -Join a network game, optionally specifying a port to connect to and player to +.It Fl n Ar host Ns Oo : Ns Ar port Oc Ns Op # Ns Ar company +Join a network game, optionally specifying a port to connect to and company to play as. .It Fl p Ar password Password used to join server. @@ -112,6 +106,14 @@ Only useful with .Fl n . .It Fl q Ar savegame Write some information about the specified savegame and exit. +.It Fl Q +Don't scan for/load NewGRF files on startup. +.Pp +Passing +.Fl Q +twice (so, +.Fl QQ +) will disable NewGRF scanning/loading entirely. .It Fl r Ar width Ns x Ns Ar height Set the resolution to .Ar width @@ -141,6 +143,8 @@ see for a full list. .It Fl x Do not automatically save to config file on exit. +.It Fl X +Do not use global folders to search for files. .El .Sh SEE ALSO .Lk https://wiki.openttd.org "Wiki" diff --git a/docs/releasing_openttd.md b/docs/releasing_openttd.md new file mode 100644 index 00000000..acb3ad9b --- /dev/null +++ b/docs/releasing_openttd.md @@ -0,0 +1,48 @@ +# Releasing OpenTTD + +This guide is for OpenTTD developers/maintainers, to release a new version of OpenTTD. + +## Step 0: Branch or Backport + +* If this is a beta version release, skip this step. + +* If this is an RC1 (first Release Candidate) build, create a new branch `release/nn` where `nn` is the major version number, then apply changes similar to [PR#9573](https://github.com/OpenTTD/OpenTTD/pull/9573). You also need to forwardport the changelog, as in [PR#10113](https://github.com/OpenTTD/OpenTTD/pull/10113). + * Update CMakeLists.txt + * Add a new (empty) AI compatibility script in bin/ai/ + * Add the new version to CheckAPIVersion in src/ai/ai_info.cpp + src/game/game_info.cpp + * Add the new version to src/script/api/ai_changelog.hpp + src/script/api/game_changelog.hpp + * Update the version of regression in bin/ai/regression/regression_info.nut + * Add a note to src/saveload/saveload.h about which savegame version is used in the branch. + +* If this is a later RC or release build and the release branch already exists, you'll need to backport fixes and language from master to this branch, which were merged after the branch diverged from master. You can use these two helper scripts: https://github.com/OpenTTD/scripts/tree/main/backport + +## Step 1: Prepare changelog documentation + +1. Update the [changelog](../changelog.txt) with new changes since the last release. + * Changelog entries are typically PR titles, but can be edited to be more helpful without context. + * Don't include fixes to things which haven't previously been released (like fixes to features which are in the same changelog). + * Order the entries by importance: `Feature > Add > Change > Fix`, then numerically by PR number. +2. Create a changelog PR, get approval, and merge. + * For beta releases, target master, otherwise target the release branch. + +## Step 2: Prepare website release announcement + +1. Go to https://github.com/OpenTTD/website/new/main/_posts and write a new announcement post. See a [previous example](https://github.com/OpenTTD/website/pull/238) for a template. +2. Create a new branch for this post and open a PR for it. +3. Write announcement text for socials like Forum/Discord/Twitter/Reddit and include it in the PR. +4. Create a Steam news image for that post and include it in the PR. +5. Check the website post (preview link via checks page) and make corrections. We usually just use the GitHub web interface for this and squash the result later. +6. Get this PR approved, but do not merge yet. + +## Step 3: Make the actual OpenTTD release + +1. Go to https://github.com/OpenTTD/OpenTTD/releases/new and create a new tag matching the release number. For the body of the release, see any older release. "Set as a pre-release" for a beta or RC, set as latest for a real release. +2. Merge website PR. +3. Wait for the OpenTTD release checks to be complete. +4. Check that website links to the new release are working and correct, using the [staging website](https://www-staging.openttd.org/). +5. If this is a full release, ask orudge to update the Microsoft Store and TrueBrain to move the release from the "testing" to "default" branch on Steam. + +## Step 4: Tell the world + +1. Tag and create a website release to trigger the actions that update the website. +2. After the website is live, make announcements on social media. You may need to coordinate with other developers who can make posts on Twitter, Reddit, Steam, and GOG. diff --git a/docs/symbol_server.md b/docs/symbol_server.md new file mode 100644 index 00000000..c1c522a1 --- /dev/null +++ b/docs/symbol_server.md @@ -0,0 +1,34 @@ +# OpenTTD's Symbol Server + +For all official releases, OpenTTD collects the Breakpad Symbols (SYM-files) and Microsoft's Symbols (PDB-files), and publishes them on our own Symbol Server (https://symbols.openttd.org). + +These symbol files are needed to analyze `crash.dmp` files as attached to issues by users. +A `crash.dmp` is created on Windows, Linux, and MacOS when a crash happens. +This combined with the `crash.log` should give a pretty good indication what was going on at the moment the game crashed. + +## Analyzing a crash.dmp + +### MSVC + +In MSVC you can add the above URL as Symbol Server (and please enable MSVC's for all other libraries), allowing you to analyze `crash.dmp`. + +Now simply open up the `crash.dmp`, and start debugging. + +### All other platforms + +The best tool to use is `minidump-stackwalk` as published in the Rust's cargo index: + +```bash +cargo install minidump-stackwalk +``` + +For how to install Rust, please see [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). + +Now run the tool like: + +```bash +minidump-stackwalk --symbols-url https://symbols.openttd.org +``` + +For convenience, the above Symbol Server also check with Mozilla's Symbol Server in case any other library but OpenTTD is requested. +This means files like `libc`, `kernel32.dll`, etc are all available on the above mentioned Symbol Server. diff --git a/media/baseset/CMakeLists.txt b/media/baseset/CMakeLists.txt index 1bf16ec0..4e1dd26d 100644 --- a/media/baseset/CMakeLists.txt +++ b/media/baseset/CMakeLists.txt @@ -18,6 +18,10 @@ set(BASESET_OTHER_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/opntitle.dat ${CMAKE_CURRENT_SOURCE_DIR}/orig_extra.grf ${CMAKE_CURRENT_SOURCE_DIR}/../openttd.32.bmp + ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Sans.ttf + ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Serif.ttf + ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Small.ttf + ${CMAKE_CURRENT_SOURCE_DIR}/OpenTTD-Mono.ttf ) # Done by the subdirectories, if nforenum / grfcodec is installed @@ -49,6 +53,7 @@ foreach(BASESET_SOURCE_FILE IN LISTS BASESET_SOURCE_FILES) MAIN_DEPENDENCY ${BASESET_SOURCE_FILE} DEPENDS ${LANG_SOURCE_FILES} ${BASESET_EXTRAGRF_FILE} + ${BASESET_EXTRAGRF_FILE}.hash ${CMAKE_SOURCE_DIR}/cmake/scripts/Baseset.cmake WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating ${BASESET_SOURCE_FILE_NAME} baseset metadata file" @@ -62,7 +67,7 @@ foreach(BASESET_OTHER_SOURCE_FILE IN LISTS BASESET_OTHER_SOURCE_FILES) get_filename_component(BASESET_OTHER_SOURCE_FILE_NAME "${BASESET_OTHER_SOURCE_FILE}" NAME) set(BASESET_OTHER_BINARY_FILE "${CMAKE_BINARY_DIR}/baseset/${BASESET_OTHER_SOURCE_FILE_NAME}") - add_custom_command(OUTPUT ${BASESET_OTHER_BINARY_FILE} + add_custom_command_timestamp(OUTPUT ${BASESET_OTHER_BINARY_FILE} COMMAND ${CMAKE_COMMAND} -E copy ${BASESET_OTHER_SOURCE_FILE} ${BASESET_OTHER_BINARY_FILE} diff --git a/media/baseset/OpenTTD-Mono.ttf b/media/baseset/OpenTTD-Mono.ttf new file mode 100644 index 00000000..ba174822 Binary files /dev/null and b/media/baseset/OpenTTD-Mono.ttf differ diff --git a/media/baseset/OpenTTD-Sans.ttf b/media/baseset/OpenTTD-Sans.ttf new file mode 100644 index 00000000..fb322a3b Binary files /dev/null and b/media/baseset/OpenTTD-Sans.ttf differ diff --git a/media/baseset/OpenTTD-Serif.ttf b/media/baseset/OpenTTD-Serif.ttf new file mode 100644 index 00000000..fd5ca433 Binary files /dev/null and b/media/baseset/OpenTTD-Serif.ttf differ diff --git a/media/baseset/OpenTTD-Small.ttf b/media/baseset/OpenTTD-Small.ttf new file mode 100644 index 00000000..df0711e1 Binary files /dev/null and b/media/baseset/OpenTTD-Small.ttf differ diff --git a/media/baseset/OpenTTD-font.md b/media/baseset/OpenTTD-font.md new file mode 100644 index 00000000..44fcb262 --- /dev/null +++ b/media/baseset/OpenTTD-font.md @@ -0,0 +1,6 @@ +# OpenTTD TrueType font + +The OpenTTD TrueType font was created by Zephyris and is maintained on [Github](https://github.com/zephyris/openttd-ttf). +It is licensed under GPL-2.0. + +The currently included files correspond to release v0.4. diff --git a/media/baseset/openttd.grf b/media/baseset/openttd.grf index 9e08fb17..7f4f6cbc 100644 Binary files a/media/baseset/openttd.grf and b/media/baseset/openttd.grf differ diff --git a/media/baseset/openttd.grf.hash b/media/baseset/openttd.grf.hash new file mode 100644 index 00000000..25a50247 --- /dev/null +++ b/media/baseset/openttd.grf.hash @@ -0,0 +1 @@ +4f03553f614a06d86dc06376db3353c7 diff --git a/media/baseset/openttd/CMakeLists.txt b/media/baseset/openttd/CMakeLists.txt index 5a98b73f..30844b88 100644 --- a/media/baseset/openttd/CMakeLists.txt +++ b/media/baseset/openttd/CMakeLists.txt @@ -5,5 +5,47 @@ # working on it / have the tools installed. if(GRFCODEC_FOUND) include(CreateGrfCommand) - create_grf_command() + create_grf_command( + NFO_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/airports.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/airport_preview.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/aqueduct.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/autorail.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/canals.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/chars.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/elrails.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/foundations.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/mono.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/oneway.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/openttd.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/palette.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/roadstops.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/signals.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/sloped_tracks.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/tramtracks.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/tunnel_portals.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/2ccmap.nfo + PNG_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/airports.png + ${CMAKE_CURRENT_SOURCE_DIR}/airport_preview.png + ${CMAKE_CURRENT_SOURCE_DIR}/aqueduct.png + ${CMAKE_CURRENT_SOURCE_DIR}/autorail.png + ${CMAKE_CURRENT_SOURCE_DIR}/canals.png + ${CMAKE_CURRENT_SOURCE_DIR}/canal_locks.png + ${CMAKE_CURRENT_SOURCE_DIR}/chars.png + ${CMAKE_CURRENT_SOURCE_DIR}/elrails.png + ${CMAKE_CURRENT_SOURCE_DIR}/foundations.png + ${CMAKE_CURRENT_SOURCE_DIR}/mono.png + ${CMAKE_CURRENT_SOURCE_DIR}/oneway.png + ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui.png + ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_build_tram.png + ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_convert_road.png + ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_convert_tram.png + ${CMAKE_CURRENT_SOURCE_DIR}/openttdgui_group_livery.png + ${CMAKE_CURRENT_SOURCE_DIR}/roadstops.png + ${CMAKE_CURRENT_SOURCE_DIR}/signals.png + ${CMAKE_CURRENT_SOURCE_DIR}/sloped_tracks.png + ${CMAKE_CURRENT_SOURCE_DIR}/tramtracks.png + ${CMAKE_CURRENT_SOURCE_DIR}/tramtracks_bare_depot.png + ${CMAKE_CURRENT_SOURCE_DIR}/tunnel_portals.png + ) endif() diff --git a/media/baseset/openttd/mono.nfo b/media/baseset/openttd/mono.nfo index f855e8f0..e17b6aae 100644 --- a/media/baseset/openttd/mono.nfo +++ b/media/baseset/openttd/mono.nfo @@ -5,233 +5,233 @@ // -1 * 0 0C "Monospaced characters (Liberation Mono)" -1 * 0 12 01 03 60 20 00 - -1 sprites/mono.png 8bpp 10 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 30 7 13 0 0 normal - -1 sprites/mono.png 8bpp 10 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 50 7 13 0 0 normal - -1 sprites/mono.png 8bpp 10 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 70 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 70 7 13 0 0 normal + -1 sprites/mono.png 8bpp 10 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 30 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 10 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 50 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 10 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 70 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 70 7 13 0 -2 normal -1 * 0 12 01 03 80 80 00 - -1 sprites/mono.png 8bpp 10 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 90 7 13 0 0 normal - -1 sprites/mono.png 8bpp 10 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 110 7 13 0 0 normal - -1 sprites/mono.png 8bpp 10 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 130 7 13 0 0 normal - -1 sprites/mono.png 8bpp 10 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 25 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 40 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 55 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 70 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 85 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 100 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 115 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 130 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 145 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 160 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 175 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 190 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 205 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 220 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 235 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 250 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 265 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 280 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 295 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 310 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 325 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 340 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 355 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 370 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 385 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 400 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 415 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 430 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 445 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 460 150 7 13 0 0 normal - -1 sprites/mono.png 8bpp 475 150 7 13 0 0 normal + -1 sprites/mono.png 8bpp 10 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 90 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 10 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 110 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 10 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 130 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 10 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 25 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 40 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 55 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 70 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 85 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 100 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 115 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 130 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 145 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 160 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 175 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 190 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 205 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 220 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 235 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 250 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 265 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 280 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 295 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 310 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 325 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 340 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 355 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 370 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 385 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 400 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 415 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 430 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 445 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 460 150 7 13 0 -2 normal + -1 sprites/mono.png 8bpp 475 150 7 13 0 -2 normal //U+0178 Latin Capital Letter Y With Diaeresis (only needed for mono as it is in the base set, but relocated by some code) -1 * 0 12 01 03 01 78 01 - -1 sprites/mono.png 8bpp 370 230 7 13 0 0 normal + -1 sprites/mono.png 8bpp 370 230 7 13 0 -2 normal diff --git a/media/baseset/opntitle.dat b/media/baseset/opntitle.dat index 2768d22c..264aaff6 100644 Binary files a/media/baseset/opntitle.dat and b/media/baseset/opntitle.dat differ diff --git a/media/baseset/orig_extra.grf b/media/baseset/orig_extra.grf index 881c4631..25193b80 100644 Binary files a/media/baseset/orig_extra.grf and b/media/baseset/orig_extra.grf differ diff --git a/media/baseset/orig_extra.grf.hash b/media/baseset/orig_extra.grf.hash new file mode 100644 index 00000000..6ca3b2ee --- /dev/null +++ b/media/baseset/orig_extra.grf.hash @@ -0,0 +1 @@ +5fdc049a7a0ada4c280239f15bc38174 diff --git a/media/baseset/orig_extra/CMakeLists.txt b/media/baseset/orig_extra/CMakeLists.txt index f71d8d4b..997e309a 100644 --- a/media/baseset/orig_extra/CMakeLists.txt +++ b/media/baseset/orig_extra/CMakeLists.txt @@ -6,9 +6,35 @@ if(GRFCODEC_FOUND) include(CreateGrfCommand) create_grf_command( - # We share some files with 'openttd' grf - ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/airports.png - ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/canals.png - ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/chars.png + NFO_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/rivers/arctic.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/rapids.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/temperate.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland_rapids.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/tropic.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/airports_orig_extra.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/canals_extra.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/chars_orig_extra.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/fix_graphics.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/fix_gui_icons.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/orig_extra.nfo + ${CMAKE_CURRENT_SOURCE_DIR}/shore.nfo + PNG_SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/rivers/arctic_brown.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/arctic_snowy.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/rapids.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/rapids_shading.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/temperate.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland_rapids.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/toyland_rapids_shading.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/tropic_desert.png + ${CMAKE_CURRENT_SOURCE_DIR}/rivers/tropic_forest.png + ${CMAKE_CURRENT_SOURCE_DIR}/fix_graphics.png + ${CMAKE_CURRENT_SOURCE_DIR}/fix_gui_icons.png + ${CMAKE_CURRENT_SOURCE_DIR}/shore.png + # We share some files with 'openttd' grf + ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/airports.png + ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/canals.png + ${CMAKE_CURRENT_SOURCE_DIR}/../openttd/chars.png ) endif() diff --git a/media/baseset/orig_extra/orig_extra.nfo b/media/baseset/orig_extra/orig_extra.nfo index e6ecca8a..ad1c7b72 100644 --- a/media/baseset/orig_extra/orig_extra.nfo +++ b/media/baseset/orig_extra/orig_extra.nfo @@ -79,6 +79,7 @@ #include "airports_orig_extra.nfo" #include "canals_extra.nfo" #include "rivers/rapids.nfo" +#include "rivers/toyland_rapids.nfo" #include "rivers/temperate.nfo" #include "rivers/arctic.nfo" #include "rivers/tropic.nfo" diff --git a/media/baseset/orig_extra/rivers/rapids.nfo b/media/baseset/orig_extra/rivers/rapids.nfo index e03d96ca..b4ed88cd 100644 --- a/media/baseset/orig_extra/rivers/rapids.nfo +++ b/media/baseset/orig_extra/rivers/rapids.nfo @@ -5,115 +5,243 @@ // -1 * 0 0C "Rapid graphics" -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 10 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 10 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 10 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 10 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 10 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 10 64 23 -31 0 normal + | sprites/rapids.png mask 10 10 + -1 sprites/rapids.png 8bpp 90 10 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 10 64 39 -31 -8 normal + | sprites/rapids.png mask 90 10 + -1 sprites/rapids.png 8bpp 170 10 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 10 64 23 -31 0 normal + | sprites/rapids.png mask 170 10 + -1 sprites/rapids.png 8bpp 250 10 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 10 64 39 -31 -8 normal + | sprites/rapids.png mask 250 10 -1 * 7 02 05 00 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 60 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 60 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 60 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 60 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 60 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 60 64 23 -31 0 normal + | sprites/rapids.png mask 10 60 + -1 sprites/rapids.png 8bpp 90 60 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 60 64 39 -31 -8 normal + | sprites/rapids.png mask 90 60 + -1 sprites/rapids.png 8bpp 170 60 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 60 64 23 -31 0 normal + | sprites/rapids.png mask 170 60 + -1 sprites/rapids.png 8bpp 250 60 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 60 64 39 -31 -8 normal + | sprites/rapids.png mask 250 60 -1 * 7 02 05 01 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 110 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 110 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 110 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 110 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 110 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 110 64 23 -31 0 normal + | sprites/rapids.png mask 10 110 + -1 sprites/rapids.png 8bpp 90 110 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 110 64 39 -31 -8 normal + | sprites/rapids.png mask 90 110 + -1 sprites/rapids.png 8bpp 170 110 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 110 64 23 -31 0 normal + | sprites/rapids.png mask 170 110 + -1 sprites/rapids.png 8bpp 250 110 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 110 64 39 -31 -8 normal + | sprites/rapids.png mask 250 110 -1 * 7 02 05 02 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 160 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 160 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 160 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 160 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 160 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 160 64 23 -31 0 normal + | sprites/rapids.png mask 10 160 + -1 sprites/rapids.png 8bpp 90 160 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 160 64 39 -31 -8 normal + | sprites/rapids.png mask 90 160 + -1 sprites/rapids.png 8bpp 170 160 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 160 64 23 -31 0 normal + | sprites/rapids.png mask 170 160 + -1 sprites/rapids.png 8bpp 250 160 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 160 64 39 -31 -8 normal + | sprites/rapids.png mask 250 160 -1 * 7 02 05 03 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 210 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 210 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 210 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 210 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 210 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 210 64 23 -31 0 normal + | sprites/rapids.png mask 10 210 + -1 sprites/rapids.png 8bpp 90 210 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 210 64 39 -31 -8 normal + | sprites/rapids.png mask 90 210 + -1 sprites/rapids.png 8bpp 170 210 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 210 64 23 -31 0 normal + | sprites/rapids.png mask 170 210 + -1 sprites/rapids.png 8bpp 250 210 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 210 64 39 -31 -8 normal + | sprites/rapids.png mask 250 210 -1 * 7 02 05 04 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 260 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 260 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 260 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 260 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 260 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 260 64 23 -31 0 normal + | sprites/rapids.png mask 10 260 + -1 sprites/rapids.png 8bpp 90 260 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 260 64 39 -31 -8 normal + | sprites/rapids.png mask 90 260 + -1 sprites/rapids.png 8bpp 170 260 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 260 64 23 -31 0 normal + | sprites/rapids.png mask 170 260 + -1 sprites/rapids.png 8bpp 250 260 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 260 64 39 -31 -8 normal + | sprites/rapids.png mask 250 260 -1 * 7 02 05 05 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 310 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 310 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 310 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 310 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 310 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 310 64 23 -31 0 normal + | sprites/rapids.png mask 10 310 + -1 sprites/rapids.png 8bpp 90 310 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 310 64 39 -31 -8 normal + | sprites/rapids.png mask 90 310 + -1 sprites/rapids.png 8bpp 170 310 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 310 64 23 -31 0 normal + | sprites/rapids.png mask 170 310 + -1 sprites/rapids.png 8bpp 250 310 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 310 64 39 -31 -8 normal + | sprites/rapids.png mask 250 310 -1 * 7 02 05 06 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 360 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 360 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 360 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 360 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 360 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 360 64 23 -31 0 normal + | sprites/rapids.png mask 10 360 + -1 sprites/rapids.png 8bpp 90 360 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 360 64 39 -31 -8 normal + | sprites/rapids.png mask 90 360 + -1 sprites/rapids.png 8bpp 170 360 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 360 64 23 -31 0 normal + | sprites/rapids.png mask 170 360 + -1 sprites/rapids.png 8bpp 250 360 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 360 64 39 -31 -8 normal + | sprites/rapids.png mask 250 360 -1 * 7 02 05 07 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 410 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 410 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 410 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 410 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 410 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 410 64 23 -31 0 normal + | sprites/rapids.png mask 10 410 + -1 sprites/rapids.png 8bpp 90 410 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 410 64 39 -31 -8 normal + | sprites/rapids.png mask 90 410 + -1 sprites/rapids.png 8bpp 170 410 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 410 64 23 -31 0 normal + | sprites/rapids.png mask 170 410 + -1 sprites/rapids.png 8bpp 250 410 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 410 64 39 -31 -8 normal + | sprites/rapids.png mask 250 410 -1 * 7 02 05 08 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 460 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 460 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 460 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 460 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 460 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 460 64 23 -31 0 normal + | sprites/rapids.png mask 10 460 + -1 sprites/rapids.png 8bpp 90 460 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 460 64 39 -31 -8 normal + | sprites/rapids.png mask 90 460 + -1 sprites/rapids.png 8bpp 170 460 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 460 64 23 -31 0 normal + | sprites/rapids.png mask 170 460 + -1 sprites/rapids.png 8bpp 250 460 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 460 64 39 -31 -8 normal + | sprites/rapids.png mask 250 460 -1 * 7 02 05 09 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 510 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 510 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 510 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 510 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 510 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 510 64 23 -31 0 normal + | sprites/rapids.png mask 10 510 + -1 sprites/rapids.png 8bpp 90 510 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 510 64 39 -31 -8 normal + | sprites/rapids.png mask 90 510 + -1 sprites/rapids.png 8bpp 170 510 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 510 64 23 -31 0 normal + | sprites/rapids.png mask 170 510 + -1 sprites/rapids.png 8bpp 250 510 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 510 64 39 -31 -8 normal + | sprites/rapids.png mask 250 510 -1 * 7 02 05 0A 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 560 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 560 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 560 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 560 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 560 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 560 64 23 -31 0 normal + | sprites/rapids.png mask 10 560 + -1 sprites/rapids.png 8bpp 90 560 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 560 64 39 -31 -8 normal + | sprites/rapids.png mask 90 560 + -1 sprites/rapids.png 8bpp 170 560 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 560 64 23 -31 0 normal + | sprites/rapids.png mask 170 560 + -1 sprites/rapids.png 8bpp 250 560 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 560 64 39 -31 -8 normal + | sprites/rapids.png mask 250 560 -1 * 7 02 05 0B 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 610 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 610 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 610 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 610 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 610 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 610 64 23 -31 0 normal + | sprites/rapids.png mask 10 610 + -1 sprites/rapids.png 8bpp 90 610 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 610 64 39 -31 -8 normal + | sprites/rapids.png mask 90 610 + -1 sprites/rapids.png 8bpp 170 610 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 610 64 23 -31 0 normal + | sprites/rapids.png mask 170 610 + -1 sprites/rapids.png 8bpp 250 610 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 610 64 39 -31 -8 normal + | sprites/rapids.png mask 250 610 -1 * 7 02 05 0C 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 660 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 660 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 660 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 660 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 660 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 660 64 23 -31 0 normal + | sprites/rapids.png mask 10 660 + -1 sprites/rapids.png 8bpp 90 660 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 660 64 39 -31 -8 normal + | sprites/rapids.png mask 90 660 + -1 sprites/rapids.png 8bpp 170 660 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 660 64 23 -31 0 normal + | sprites/rapids.png mask 170 660 + -1 sprites/rapids.png 8bpp 250 660 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 660 64 39 -31 -8 normal + | sprites/rapids.png mask 250 660 -1 * 7 02 05 0D 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 710 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 710 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 710 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 710 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 710 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 710 64 23 -31 0 normal + | sprites/rapids.png mask 10 710 + -1 sprites/rapids.png 8bpp 90 710 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 710 64 39 -31 -8 normal + | sprites/rapids.png mask 90 710 + -1 sprites/rapids.png 8bpp 170 710 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 710 64 23 -31 0 normal + | sprites/rapids.png mask 170 710 + -1 sprites/rapids.png 8bpp 250 710 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 710 64 39 -31 -8 normal + | sprites/rapids.png mask 250 710 -1 * 7 02 05 0E 01 00 00 00 -1 * 4 01 05 01 04 - -1 sprites/rapids.png 8bpp 10 760 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 90 760 64 39 -31 -8 normal - -1 sprites/rapids.png 8bpp 170 760 64 23 -31 0 normal - -1 sprites/rapids.png 8bpp 250 760 64 39 -31 -8 normal + -1 sprites/rapids.png 8bpp 10 760 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 10 760 64 23 -31 0 normal + | sprites/rapids.png mask 10 760 + -1 sprites/rapids.png 8bpp 90 760 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 90 760 64 39 -31 -8 normal + | sprites/rapids.png mask 90 760 + -1 sprites/rapids.png 8bpp 170 760 64 23 -31 0 normal + | sprites/rapids_shading.png 32bpp 170 760 64 23 -31 0 normal + | sprites/rapids.png mask 170 760 + -1 sprites/rapids.png 8bpp 250 760 64 39 -31 -8 normal + | sprites/rapids_shading.png 32bpp 250 760 64 39 -31 -8 normal + | sprites/rapids.png mask 250 760 -1 * 7 02 05 0F 01 00 00 00 -1 * 39 02 05 10 80 00 01 10 diff --git a/media/baseset/orig_extra/rivers/rapids_shading.png b/media/baseset/orig_extra/rivers/rapids_shading.png new file mode 100644 index 00000000..2606f9d5 Binary files /dev/null and b/media/baseset/orig_extra/rivers/rapids_shading.png differ diff --git a/media/baseset/orig_extra/rivers/toyland.nfo b/media/baseset/orig_extra/rivers/toyland.nfo index 8b6dedd3..41d6ff56 100644 --- a/media/baseset/orig_extra/rivers/toyland.nfo +++ b/media/baseset/orig_extra/rivers/toyland.nfo @@ -3,7 +3,7 @@ // 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. // 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 . // - -1 * 0 0C "Toyland river graphics by andythenorth (Andrew Parkhouse)" + -1 * 0 0C "Toyland river graphics by zephyris (Richard Wheeler)" -1 * 4 01 05 01 3C -1 sprites/toyland.png 8bpp 10 10 38 19 -5 0 normal -1 sprites/toyland.png 8bpp 58 10 38 18 -5 13 normal diff --git a/media/baseset/orig_extra/rivers/toyland.png b/media/baseset/orig_extra/rivers/toyland.png index 61ff2243..80db3e2a 100644 Binary files a/media/baseset/orig_extra/rivers/toyland.png and b/media/baseset/orig_extra/rivers/toyland.png differ diff --git a/media/baseset/orig_extra/rivers/toyland_rapids.nfo b/media/baseset/orig_extra/rivers/toyland_rapids.nfo new file mode 100644 index 00000000..fc61bcb2 --- /dev/null +++ b/media/baseset/orig_extra/rivers/toyland_rapids.nfo @@ -0,0 +1,73 @@ +// This file is part of OpenTTD. +// 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. +// 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. +// 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 . +// + -1 * 0 0C "Toyland rapid graphics by zephyris (Richard Wheeler)" + -1 * 4 01 05 01 04 + -1 sprites/toyland_rapids.png 8bpp 10 10 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 10 10 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 10 10 + -1 sprites/toyland_rapids.png 8bpp 90 10 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 90 10 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 90 10 + -1 sprites/toyland_rapids.png 8bpp 170 10 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 170 10 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 170 10 + -1 sprites/toyland_rapids.png 8bpp 250 10 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 250 10 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 250 10 + -1 * 7 02 05 00 01 00 00 00 + + -1 * 4 01 05 01 04 + -1 sprites/toyland_rapids.png 8bpp 10 60 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 10 60 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 10 60 + -1 sprites/toyland_rapids.png 8bpp 90 60 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 90 60 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 90 60 + -1 sprites/toyland_rapids.png 8bpp 170 60 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 170 60 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 170 60 + -1 sprites/toyland_rapids.png 8bpp 250 60 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 250 60 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 250 60 + -1 * 7 02 05 01 01 00 00 00 + + -1 * 4 01 05 01 04 + -1 sprites/toyland_rapids.png 8bpp 10 110 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 10 110 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 10 110 + -1 sprites/toyland_rapids.png 8bpp 90 110 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 90 110 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 90 110 + -1 sprites/toyland_rapids.png 8bpp 170 110 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 170 110 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 170 110 + -1 sprites/toyland_rapids.png 8bpp 250 110 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 250 110 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 250 110 + -1 * 7 02 05 02 01 00 00 00 + + -1 * 4 01 05 01 04 + -1 sprites/toyland_rapids.png 8bpp 10 160 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 10 160 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 10 160 + -1 sprites/toyland_rapids.png 8bpp 90 160 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 90 160 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 90 160 + -1 sprites/toyland_rapids.png 8bpp 170 160 64 23 -31 0 normal + | sprites/toyland_rapids_shading.png 32bpp 170 160 64 23 -31 0 normal + | sprites/toyland_rapids.png mask 170 160 + -1 sprites/toyland_rapids.png 8bpp 250 160 64 39 -31 -8 normal + | sprites/toyland_rapids_shading.png 32bpp 250 160 64 39 -31 -8 normal + | sprites/toyland_rapids.png mask 250 160 + -1 * 7 02 05 03 01 00 00 00 + + -1 * 39 02 05 10 80 00 01 04 + 00 00 + 01 00 + 02 00 + 03 00 + -1 * 6 07 83 01 \7! 03 01 + -1 * 7 03 05 01 05 00 10 00 diff --git a/media/baseset/orig_extra/rivers/toyland_rapids.png b/media/baseset/orig_extra/rivers/toyland_rapids.png new file mode 100644 index 00000000..7216b1b4 Binary files /dev/null and b/media/baseset/orig_extra/rivers/toyland_rapids.png differ diff --git a/media/baseset/orig_extra/rivers/toyland_rapids_shading.png b/media/baseset/orig_extra/rivers/toyland_rapids_shading.png new file mode 100644 index 00000000..946a0ef0 Binary files /dev/null and b/media/baseset/orig_extra/rivers/toyland_rapids_shading.png differ diff --git a/os/emscripten/Dockerfile b/os/emscripten/Dockerfile index ae3579ec..178f5650 100644 --- a/os/emscripten/Dockerfile +++ b/os/emscripten/Dockerfile @@ -1,4 +1,4 @@ -FROM emscripten/emsdk:3.1.28 +FROM emscripten/emsdk:3.1.42 COPY emsdk-liblzma.patch / RUN cd /emsdk/upstream/emscripten && patch -p1 < /emsdk-liblzma.patch diff --git a/os/emscripten/README.md b/os/emscripten/README.md index cf8e3ed6..9184b014 100644 --- a/os/emscripten/README.md +++ b/os/emscripten/README.md @@ -7,7 +7,7 @@ It takes care of a few things: First, build the docker image by navigating in the folder this `README.md` is in, and executing: ``` - docker build -t emsdk-lzma . + docker build -t emsdk-openttd . ``` Next, navigate back to the root folder of this project. @@ -15,15 +15,15 @@ Next, navigate back to the root folder of this project. Now we build the host tools first: ``` mkdir build-host - docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build-host emsdk-lzma cmake .. -DOPTION_TOOLS_ONLY=ON - docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build-host emsdk-lzma make -j$(nproc) tools + docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build-host emsdk-openttd cmake .. -DOPTION_TOOLS_ONLY=ON + docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build-host emsdk-openttd make -j$(nproc) tools ``` Finally, we build the actual game: ``` mkdir build - docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build emsdk-lzma emcmake cmake .. -DHOST_BINARY_DIR=../build-host -DCMAKE_BUILD_TYPE=Release -DOPTION_USE_ASSERTS=OFF - docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build emsdk-lzma emmake make -j$(nproc) + docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build emsdk-openttd emcmake cmake .. -DHOST_BINARY_DIR=../build-host -DCMAKE_BUILD_TYPE=Release -DOPTION_USE_ASSERTS=OFF + docker run -it --rm -v $(pwd):$(pwd) -u $(id -u):$(id -g) --workdir $(pwd)/build emsdk-openttd emmake make -j$(nproc) ``` In the `build` folder you will now see `openttd.html`. diff --git a/os/emscripten/cmake/FindLibLZMA.cmake b/os/emscripten/cmake/FindLibLZMA.cmake index e8a024c4..cd6b44ad 100644 --- a/os/emscripten/cmake/FindLibLZMA.cmake +++ b/os/emscripten/cmake/FindLibLZMA.cmake @@ -1,5 +1,5 @@ -# LibLZMA is a recent addition to the emscripten SDK, so it is possible -# someone hasn't updated their SDK yet. Test out if the SDK supports LibLZMA. +# LibLZMA is a custom addition to the emscripten SDK, so it is possible +# someone patched their SDK. Test out if the SDK supports LibLZMA. include(CheckCXXSourceCompiles) set(CMAKE_REQUIRED_FLAGS "-sUSE_LIBLZMA=1") diff --git a/os/emscripten/emsdk-liblzma.patch b/os/emscripten/emsdk-liblzma.patch index fbb24e7c..7bfdd47d 100644 --- a/os/emscripten/emsdk-liblzma.patch +++ b/os/emscripten/emsdk-liblzma.patch @@ -1,30 +1,20 @@ -From 90dd4d4c6b1cedec338ff5b375fffca93700f7bc Mon Sep 17 00:00:00 2001 +From 84d0e9112d5c87a714abd21ec8547921f46f37b5 Mon Sep 17 00:00:00 2001 From: milek7 Date: Tue, 8 Dec 2020 01:03:31 +0100 Subject: [PATCH] Add liblzma port --- -Source: https://github.com/emscripten-core/emscripten/pull/12990 + src/settings.js | 4 ++ + tools/ports/liblzma.py | 151 +++++++++++++++++++++++++++++++++++++++++ + tools/settings.py | 1 + + 3 files changed, 156 insertions(+) + create mode 100644 tools/ports/liblzma.py -Modifed by OpenTTD to have the bare minimum needed to work. Otherwise there -are constantly conflicts when trying to apply this patch to different versions -of emsdk. - -diff --git a/tools/settings.py b/tools/settings.py ---- a/tools/settings.py -+++ b/tools/settings.py -@@ -40,6 +40,7 @@ PORTS_SETTINGS = { - 'USE_SDL_NET', - 'USE_SDL_GFX', - 'USE_LIBJPEG', -+ 'USE_LIBLZMA', - 'USE_OGG', - 'USE_REGAL', - 'USE_BOOST_HEADERS', diff --git a/src/settings.js b/src/settings.js +index f93140d..7b6bec9 100644 --- a/src/settings.js +++ b/src/settings.js -@@ -1450,6 +1450,10 @@ var USE_GIFLIB = false; +@@ -1451,6 +1451,10 @@ var USE_GIFLIB = false; // [compile+link] var USE_LIBJPEG = false; @@ -35,9 +25,9 @@ diff --git a/src/settings.js b/src/settings.js // 1 = use libpng from emscripten-ports // [compile+link] var USE_LIBPNG = false; - diff --git a/tools/ports/liblzma.py b/tools/ports/liblzma.py new file mode 100644 +index 0000000..6872a8b --- /dev/null +++ b/tools/ports/liblzma.py @@ -0,0 +1,151 @@ @@ -51,8 +41,8 @@ new file mode 100644 +import logging +from pathlib import Path + -+VERSION = '5.4.0' -+HASH = '29b2cd25bb5b234b329ffe9547692d2c29be393db9d8d4ce70a66dfdaebd54433e79a89d80c57e58cd4559c3c68b9845507d5fedf3eec1c528a81e3d9ddbd811' ++VERSION = '5.4.2' ++HASH = '149f980338bea3d66de1ff5994b2b236ae1773135eda68b62b009df0c9dcdf5467f8cb2c06da95a71b6556d60bd3d21f475feced34d5dfdb80ee95416a2f9737' + + +def needed(settings): @@ -192,3 +182,17 @@ new file mode 100644 +#endif +#define VERSION "5.4.0" +''' +diff --git a/tools/settings.py b/tools/settings.py +index 10d6ca0..827e4a9 100644 +--- a/tools/settings.py ++++ b/tools/settings.py +@@ -40,6 +40,7 @@ PORTS_SETTINGS = { + 'USE_SDL_NET', + 'USE_SDL_GFX', + 'USE_LIBJPEG', ++ 'USE_LIBLZMA', + 'USE_OGG', + 'USE_REGAL', + 'USE_BOOST_HEADERS', +-- +2.34.1 diff --git a/os/emscripten/pre.js b/os/emscripten/pre.js index 2fb64101..8e46ae34 100644 --- a/os/emscripten/pre.js +++ b/os/emscripten/pre.js @@ -1,8 +1,8 @@ -Module.arguments.push('-mnull', '-snull', '-vsdl:relative_mode'); +Module.arguments.push('-mnull', '-snull', '-vsdl'); Module['websocket'] = { url: function(host, port, proto) { /* openttd.org hosts a WebSocket proxy for the content service. */ if (host == "content.openttd.org" && port == 3978 && proto == "tcp") { - return "wss://content.openttd.org/"; + return "wss://bananas-server.openttd.org/"; } /* Everything else just tries to make a default WebSocket connection. @@ -30,46 +30,47 @@ Module.preRun.push(function() { Module.addRunDependency('syncfs'); FS.syncfs(true, function (err) { - /* FS.mkdir() tends to fail if parent folders do not exist. */ - if (!FS.analyzePath(content_download_dir).exists) { - FS.mkdir(content_download_dir); - } - if (!FS.analyzePath(content_download_dir + '/baseset').exists) { - FS.mkdir(content_download_dir + '/baseset'); - } - - /* Check if the OpenGFX baseset is already downloaded. */ - if (!FS.analyzePath(content_download_dir + '/baseset/opengfx-0.6.0.tar').exists) { - window.openttd_downloaded_opengfx = true; - FS.createPreloadedFile(content_download_dir + '/baseset', 'opengfx-0.6.0.tar', 'https://installer.cdn.openttd.org/emscripten/opengfx-0.6.0.tar', true, true); - } else { - /* Fake dependency increase, so the counter is stable. */ - Module.addRunDependency('opengfx'); - Module.removeRunDependency('opengfx'); - } - Module.removeRunDependency('syncfs'); }); window.openttd_syncfs_shown_warning = false; - window.openttd_syncfs = function() { + window.openttd_syncfs = function(callback) { /* Copy the virtual FS to the persistent storage. */ - FS.syncfs(false, function (err) { }); - - /* On first time, warn the user about the volatile behaviour of - * persistent storage. */ - if (!window.openttd_syncfs_shown_warning) { - window.openttd_syncfs_shown_warning = true; - Module.onWarningFs(); - } + FS.syncfs(false, function (err) { + /* On first time, warn the user about the volatile behaviour of + * persistent storage. */ + if (!window.openttd_syncfs_shown_warning) { + window.openttd_syncfs_shown_warning = true; + Module.onWarningFs(); + } + + if (callback) callback(); + }); } window.openttd_exit = function() { - Module.onExit(); + window.openttd_syncfs(Module.onExit); } window.openttd_abort = function() { - Module.onAbort(); + window.openttd_syncfs(Module.onAbort); + } + + window.openttd_bootstrap = function(current, total) { + Module.onBootstrap(current, total); + } + + window.openttd_bootstrap_failed = function() { + Module.onBootstrapFailed(); + } + + window.openttd_bootstrap_reload = function() { + window.openttd_syncfs(function() { + Module.onBootstrapReload(); + setTimeout(function() { + location.reload(); + }, 1000); + }); } window.openttd_server_list = function() { @@ -123,11 +124,3 @@ Module.preRun.push(function() { return ret; } }); - -Module.postRun.push(function() { - /* Check if we downloaded OpenGFX; if so, sync the virtual FS back to the - * IDBFS so OpenGFX is stored persistent. */ - if (window['openttd_downloaded_opengfx']) { - FS.syncfs(false, function (err) { }); - } -}); diff --git a/os/emscripten/shell.html b/os/emscripten/shell.html index af031c6d..21f720e7 100644 --- a/os/emscripten/shell.html +++ b/os/emscripten/shell.html @@ -75,7 +75,6 @@ } #message { color: #101010; - height: 54px; padding: 4px 4px; } @@ -144,6 +143,8 @@ })(), setStatus: function(text) { + if (document.getElementById("canvas").style.display == "none") return; + var m = text.match(/^([^(]+)\((\d+(\.\d+)?)\/(\d+)\)$/); if (m) { @@ -171,6 +172,27 @@ document.getElementById("message").innerHTML = "Preparing game ..."; }, + onBootstrap: function(current, total) { + document.getElementById("canvas").style.display = "none"; + + document.getElementById("title").innerHTML = "Missing base graphics"; + document.getElementById("message").innerHTML = "OpenTTD is downloading base graphics.

    " + current + " / " + total + " bytes downloaded."; + }, + + onBootstrapFailed: function(current, total) { + document.getElementById("canvas").style.display = "none"; + + document.getElementById("title").innerHTML = "Missing base graphics"; + document.getElementById("message").innerHTML = "Failed to download base graphics.
    The game cannot start without base graphics.

    Please check your Internet connection and/or the console log.
    Reload your browser to try again."; + }, + + onBootstrapReload: function() { + document.getElementById("canvas").style.display = "none"; + + document.getElementById("title").innerHTML = "Missing base graphics"; + document.getElementById("message").innerHTML = "Downloading base graphics done.

    Your browser will reload to start the game."; + }, + onExit: function() { document.getElementById("canvas").style.display = "none"; diff --git a/os/linux/shf-compressed.patch b/os/linux/shf-compressed.patch new file mode 100644 index 00000000..6ec7865b --- /dev/null +++ b/os/linux/shf-compressed.patch @@ -0,0 +1,10 @@ +--- a/usr/include/elf.h 2023-12-30 13:46:27.038645199 +0100 ++++ b/usr/include/elf.h 2023-12-30 13:46:42.278641893 +0100 +@@ -365,6 +365,7 @@ + required */ + #define SHF_GROUP (1 << 9) /* Section is member of a group. */ + #define SHF_TLS (1 << 10) /* Section hold thread-local data. */ ++#define SHF_COMPRESSED (1 << 11) /* Section with compressed data. */ + #define SHF_MASKOS 0x0ff00000 /* OS-specific. */ + #define SHF_MASKPROC 0xf0000000 /* Processor-specific */ + #define SHF_ORDERED (1 << 30) /* Special ordering requirement diff --git a/os/windows/openttd.manifest b/os/windows/openttd.manifest index cb536a81..21fee421 100644 --- a/os/windows/openttd.manifest +++ b/os/windows/openttd.manifest @@ -15,8 +15,6 @@ - - diff --git a/regression/CMakeLists.txt b/regression/CMakeLists.txt new file mode 100644 index 00000000..340e29c2 --- /dev/null +++ b/regression/CMakeLists.txt @@ -0,0 +1,24 @@ + # Copy the regression configuration in a special folder, so all autogenerated + # folders end up in the same place after running regression. + add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/regression.cfg + COMMAND ${CMAKE_COMMAND} -E copy + ${CMAKE_CURRENT_SOURCE_DIR}/regression.cfg + ${CMAKE_CURRENT_BINARY_DIR}/regression.cfg + MAIN_DEPENDENCY ${CMAKE_CURRENT_SOURCE_DIR}/regression.cfg + COMMENT "Copying regression.cfg regression file" + ) + + # Create a new target which copies all regression files + # Subdirectory targets will add themselves as dependencies + add_custom_target(regression_files + ALL # this is needed because 'make test' doesn't resolve dependencies, and otherwise this is never executed + DEPENDS + ${CMAKE_BINARY_DIR}/regression/regression.cfg + ) + + # Create a new target which runs the regression + # Subdirectory targets will add themselves as dependencies + add_custom_target(regression) + + add_subdirectory(regression) + add_subdirectory(stationlist) diff --git a/regression/regression/CMakeLists.txt b/regression/regression/CMakeLists.txt new file mode 100644 index 00000000..9aab44ef --- /dev/null +++ b/regression/regression/CMakeLists.txt @@ -0,0 +1,8 @@ +include(CreateRegression) +create_regression( + ${CMAKE_CURRENT_SOURCE_DIR}/info.nut + ${CMAKE_CURRENT_SOURCE_DIR}/main.nut + ${CMAKE_CURRENT_SOURCE_DIR}/require.nut + ${CMAKE_CURRENT_SOURCE_DIR}/result.txt + ${CMAKE_CURRENT_SOURCE_DIR}/test.sav +) diff --git a/regression/regression/info.nut b/regression/regression/info.nut index 8799d986..9c775eed 100644 --- a/regression/regression/info.nut +++ b/regression/regression/info.nut @@ -4,7 +4,7 @@ class Regression extends AIInfo { function GetShortName() { return "REGR"; } function GetDescription() { return "This runs regression-tests on some commands. On the same map the result should always be the same."; } function GetVersion() { return 1; } - function GetAPIVersion() { return "13"; } + function GetAPIVersion() { return "14"; } function GetDate() { return "2007-03-18"; } function CreateInstance() { return "Regression"; } function UseAsRandomAI() { return false; } diff --git a/regression/regression/main.nut b/regression/regression/main.nut index 7621c49c..b2daa5b6 100644 --- a/regression/regression/main.nut +++ b/regression/regression/main.nut @@ -1107,6 +1107,7 @@ function Regression::Rail() print(" IsRailTile(): " + AIRail.IsRailTile(33411)); print(" BuildRailDepot(): " + AIRail.BuildRailDepot(0, 1)); print(" BuildRailDepot(): " + AIRail.BuildRailDepot(33411, 33411)); + print(" BuildRailDepot(): " + AIRail.BuildRailDepot(33411, 33410)); print(" BuildRailDepot(): " + AIRail.BuildRailDepot(33411, 33414)); print(" BuildRailDepot(): " + AIRail.BuildRailDepot(33411, 33412)); print(" GetRailDepotFrontTile(): " + AIRail.GetRailDepotFrontTile(33411)); @@ -1203,6 +1204,7 @@ function Regression::Road() print(" IsRoadTile(): " + AIRoad.IsRoadTile(33411)); print(" BuildRoadDepot(): " + AIRoad.BuildRoadDepot(0, 1)); print(" BuildRoadDepot(): " + AIRoad.BuildRoadDepot(33411, 33411)); + print(" BuildRoadDepot(): " + AIRoad.BuildRoadDepot(33411, 33410)); print(" BuildRoadDepot(): " + AIRoad.BuildRoadDepot(33411, 33414)); print(" BuildRoadDepot(): " + AIRoad.BuildRoadDepot(33411, 33412)); print(" HasRoadType(Road): " + AIRoad.HasRoadType(33411, AIRoad.ROADTYPE_ROAD)); @@ -1812,10 +1814,17 @@ function Regression::Vehicle() print(" GetLastErrorString(): " + AIError.GetLastErrorString()); local list = AIVehicleList(); + local in_depot = AIVehicleList(AIVehicle.IsInDepot); + local IsType = function(vehicle_id, type) { + return AIVehicle.GetVehicleType(vehicle_id) == type; + } + local rv_list = AIVehicleList(IsType, AIVehicle.VT_ROAD); print(""); print("--VehicleList--"); print(" Count(): " + list.Count()); + print(" InDepot Count(): " + in_depot.Count()); + print(" RoadVehicle Count(): " + rv_list.Count()); list.Valuate(AIVehicle.GetLocation); print(" Location ListDump:"); for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) { @@ -2017,5 +2026,12 @@ function Regression::Start() print(" IsEventWaiting: false"); this.Math(); + + /* Check Valuate() is actually limited, MUST BE THE LAST TEST. */ + print("--Valuate() with excessive CPU usage--") + local list = AIList(); + list.AddItem(0, 0); + local Infinite = function(id) { while(true); } + list.Valuate(Infinite); } diff --git a/regression/regression/result.txt b/regression/regression/result.txt index dc3e2948..57c8a400 100644 --- a/regression/regression/result.txt +++ b/regression/regression/result.txt @@ -1,4 +1,3 @@ - --TestInit-- Ops: 9988 TickTest: 1 @@ -88,21 +87,21 @@ abs( 21): 21 --AIBase-- - Rand(): -54346916 - Rand(): -937374575 - Rand(): 823953997 + Rand(): 2113409458 + Rand(): 2000129769 + Rand(): 1788051963 RandRange(0): 0 RandRange(0): 0 RandRange(0): 0 RandRange(1): 0 RandRange(1): 0 RandRange(1): 0 + RandRange(2): 0 + RandRange(2): 0 RandRange(2): 1 - RandRange(2): 1 - RandRange(2): 1 - RandRange(1000000): 966676 - RandRange(1000000): 289525 - RandRange(1000000): 170283 + RandRange(1000000): 338687 + RandRange(1000000): 274895 + RandRange(1000000): 217539 Chance(1, 2): false Chance(1, 2): true Chance(1, 2): false @@ -420,144 +419,144 @@ 1098 => 46116 1099 => 46158 Randomize ListDump: - 1 => -200078348 - 2 => -29799264 - 1000 => 1630721656 - 1001 => 959306175 - 1002 => 1527421791 - 1003 => 1259692483 - 1004 => -1289244298 - 1005 => -1572996668 - 1006 => -2069479746 - 1007 => -1819131606 - 1008 => -1007163964 - 1009 => -1185394870 - 1010 => -1471365065 - 1011 => 364354366 - 1012 => -1478084253 - 1013 => 405281367 - 1014 => -11170062 - 1015 => 156767750 - 1016 => 1288924796 - 1017 => 1796884876 - 1018 => -1947073702 - 1019 => -1999614238 - 1020 => -231292809 - 1021 => 966621566 - 1022 => -606766557 - 1023 => -1138727825 - 1024 => -749544262 - 1025 => 2004771271 - 1026 => 686734186 - 1027 => 923274744 - 1028 => -1672035149 - 1029 => -1642064950 - 1030 => 1363389551 - 1031 => -559500928 - 1032 => 1656196991 - 1033 => 1655354425 - 1034 => -1027156689 - 1035 => 1952644328 - 1036 => 1217870217 - 1037 => 242274100 - 1038 => 201816080 - 1039 => 2127464758 - 1040 => 446043650 - 1041 => -319728455 - 1042 => 204701002 - 1043 => -571265398 - 1044 => -1422217131 - 1045 => -391208397 - 1046 => -1822628371 - 1047 => -1499755350 - 1048 => -1422137641 - 1049 => 1621693134 - 1051 => -1428728134 - 1052 => -147587573 - 1053 => 681719500 - 1054 => 1172011190 - 1055 => -1834344882 - 1056 => 1157634586 - 1057 => 1902133676 - 1058 => -1967780161 - 1059 => -1618025531 - 1060 => -810220453 - 1061 => 1582854921 - 1062 => -410004643 - 1063 => 1159917159 - 1064 => -1377804984 - 1065 => -738843914 - 1066 => -1578756103 - 1067 => -464090986 - 1068 => 1711504679 - 1069 => 545330655 - 1070 => 379462570 - 1071 => 514511099 - 1072 => -1813251176 - 1073 => 1424958266 - 1074 => -825255131 - 1075 => 539054595 - 1076 => -1764192010 - 1077 => -1243277769 - 1078 => 2017874281 - 1079 => -1972353607 - 1080 => 1879761467 - 1081 => 1638986560 - 1082 => -1832287507 - 1083 => -492411882 - 1084 => 658940812 - 1085 => -1044199400 - 1086 => 1586504918 - 1087 => -125492611 - 1088 => -1562883174 - 1089 => -1013778441 - 1090 => 1560228607 - 1091 => -550265689 - 1092 => 524767105 - 1093 => -713387661 - 1094 => 1425927738 - 1095 => 942653932 - 1096 => 1233220698 - 1097 => 1313602368 - 1098 => -140318584 - 1099 => 1199179892 + 1 => 1667006376 + 2 => 814756458 + 1000 => 2792131700 + 1001 => 3417650573 + 1002 => 1856129988 + 1003 => 1800973341 + 1004 => 4197962148 + 1005 => 2463509731 + 1006 => 2312121797 + 1007 => 1357932132 + 1008 => 1603755907 + 1009 => 1718096015 + 1010 => 3850074449 + 1011 => 2711130211 + 1012 => 2371249199 + 1013 => 881020769 + 1014 => 3366660077 + 1015 => 808768948 + 1016 => 3035331984 + 1017 => 2813590961 + 1018 => 2745021820 + 1019 => 3075151719 + 1020 => 2553774560 + 1021 => 4267762096 + 1022 => 3863175846 + 1023 => 4198397908 + 1024 => 817599906 + 1025 => 3149240362 + 1026 => 3003005979 + 1027 => 1214815375 + 1028 => 3784363817 + 1029 => 3181864540 + 1030 => 325341059 + 1031 => 1011889231 + 1032 => 3142617173 + 1033 => 1197220206 + 1034 => 4060510885 + 1035 => 3596342467 + 1036 => 219406671 + 1037 => 3695508783 + 1038 => 2823603997 + 1039 => 2625659720 + 1040 => 4113498476 + 1041 => 1125297786 + 1042 => 671905104 + 1043 => 1231077134 + 1044 => 892292375 + 1045 => 2441486929 + 1046 => 1804593432 + 1047 => 2536560053 + 1048 => 1896826021 + 1049 => 1672512966 + 1051 => 977884299 + 1052 => 681948608 + 1053 => 3853505792 + 1054 => 4118706553 + 1055 => 3581698138 + 1056 => 3073782502 + 1057 => 1084753140 + 1058 => 2266056077 + 1059 => 1239805090 + 1060 => 1183528423 + 1061 => 501361238 + 1062 => 66542127 + 1063 => 775638990 + 1064 => 1111474321 + 1065 => 3465462871 + 1066 => 2317535037 + 1067 => 878310882 + 1068 => 2231368582 + 1069 => 2353633007 + 1070 => 179259867 + 1071 => 1322707275 + 1072 => 1474105363 + 1073 => 619989187 + 1074 => 3221603092 + 1075 => 2400416540 + 1076 => 3926392705 + 1077 => 1122978123 + 1078 => 3266139701 + 1079 => 2948697341 + 1080 => 3262493501 + 1081 => 2200252596 + 1082 => 4091101485 + 1083 => 2797438343 + 1084 => 2608201933 + 1085 => 2577605442 + 1086 => 1178956760 + 1087 => 3047709109 + 1088 => 1065186815 + 1089 => 841440515 + 1090 => 842182476 + 1091 => 289059855 + 1092 => 2114106829 + 1093 => 436435334 + 1094 => 111052607 + 1095 => 81827083 + 1096 => 1961213887 + 1097 => 1374385392 + 1098 => 3255118186 + 1099 => 2245402931 KeepTop(10): - 1 => -200078348 - 2 => -29799264 - 1000 => 1630721656 - 1001 => 959306175 - 1002 => 1527421791 - 1003 => 1259692483 - 1004 => -1289244298 - 1005 => -1572996668 - 1006 => -2069479746 - 1007 => -1819131606 + 1 => 1667006376 + 2 => 814756458 + 1000 => 2792131700 + 1001 => 3417650573 + 1002 => 1856129988 + 1003 => 1800973341 + 1004 => 4197962148 + 1005 => 2463509731 + 1006 => 2312121797 + 1007 => 1357932132 KeepBottom(8): - 1000 => 1630721656 - 1001 => 959306175 - 1002 => 1527421791 - 1003 => 1259692483 - 1004 => -1289244298 - 1005 => -1572996668 - 1006 => -2069479746 - 1007 => -1819131606 + 1000 => 2792131700 + 1001 => 3417650573 + 1002 => 1856129988 + 1003 => 1800973341 + 1004 => 4197962148 + 1005 => 2463509731 + 1006 => 2312121797 + 1007 => 1357932132 RemoveBottom(2): - 1000 => 1630721656 - 1001 => 959306175 - 1002 => 1527421791 - 1003 => 1259692483 - 1004 => -1289244298 - 1005 => -1572996668 + 1000 => 2792131700 + 1001 => 3417650573 + 1002 => 1856129988 + 1003 => 1800973341 + 1004 => 4197962148 + 1005 => 2463509731 RemoveTop(2): - 1002 => 1527421791 - 1003 => 1259692483 - 1004 => -1289244298 - 1005 => -1572996668 + 1002 => 1856129988 + 1003 => 1800973341 + 1004 => 4197962148 + 1005 => 2463509731 RemoveList({1003, 1004}): - 1002 => 1527421791 - 1005 => -1572996668 + 1002 => 1856129988 + 1005 => 2463509731 KeepList({1003, 1004, 1005}): - 1005 => -1572996668 + 1005 => 2463509731 AddList({1005, 4000, 4001, 4002}): 1005 => 1005 4000 => 8000 @@ -588,7 +587,7 @@ ERROR: IsEnd() is invalid as Begin() is never called SetName(): false GetLastErrorString(): ERR_NAME_IS_NOT_UNIQUE GetName(): Regression - GetPresidentName(): E. McAlpine + GetPresidentName(): F. Gribble SetPresidentName(): true GetPresidentName(): Regression AI GetBankBalance(): 100000 @@ -7498,6 +7497,7 @@ ERROR: IsEnd() is invalid as Begin() is never called BuildRailDepot(): false BuildRailDepot(): false BuildRailDepot(): true + BuildRailDepot(): true BuildRailDepot(): false GetRailDepotFrontTile(): 33412 IsBuildable(): false @@ -7591,11 +7591,12 @@ ERROR: IsEnd() is invalid as Begin() is never called BuildRoadDepot(): false BuildRoadDepot(): false BuildRoadDepot(): true + BuildRoadDepot(): true BuildRoadDepot(): false HasRoadType(Road): true HasRoadType(Tram): false - GetLastError(): 260 - GetLastErrorString(): ERR_AREA_NOT_CLEAR + GetLastError(): 259 + GetLastErrorString(): ERR_ALREADY_BUILT GetErrorCategory(): 1 IsRoadTile(): false GetRoadDepotFrontTile(): 33412 @@ -9311,7 +9312,7 @@ ERROR: IsEnd() is invalid as Begin() is never called IsStoppedInDepot(): false --Accounting-- GetCosts(): -5947 - Should be: -5947 + Should be: -5946 GetName(): Road Vehicle #1 SetName(): true GetName(): MyVehicleName @@ -9320,12 +9321,12 @@ ERROR: IsEnd() is invalid as Begin() is never called GetLocation(): 33417 GetEngineType(): 153 GetUnitNumber(): 1 - GetAge(): 0 + GetAge(): 1 GetMaxAge(): 5490 - GetAgeLeft(): 5490 + GetAgeLeft(): 5489 GetCurrentSpeed(): 7 GetRunningCost(): 421 - GetProfitThisYear(): 0 + GetProfitThisYear(): -1 GetProfitLastYear(): 0 GetCurrentValue(): 5947 GetVehicleType(): 1 @@ -9335,7 +9336,7 @@ ERROR: IsEnd() is invalid as Begin() is never called IsInDepot(): false GetNumWagons(): 1 GetWagonEngineType(): 153 - GetWagonAge(): 0 + GetWagonAge(): 1 GetLength(): 8 GetOwner(): 1 BuildVehicle(): 14 @@ -9389,6 +9390,8 @@ ERROR: IsEnd() is invalid as Begin() is never called --VehicleList-- Count(): 5 + InDepot Count(): 4 + RoadVehicle Count(): 2 Location ListDump: 13 => 33417 12 => 33417 @@ -9408,11 +9411,11 @@ ERROR: IsEnd() is invalid as Begin() is never called 14 => 1 12 => 1 Age ListDump: - 17 => 1 - 16 => 1 - 14 => 1 - 13 => 1 12 => 1 + 17 => 0 + 16 => 0 + 14 => 0 + 13 => 0 MaxAge ListDump: 16 => 10980 14 => 10980 @@ -9420,10 +9423,10 @@ ERROR: IsEnd() is invalid as Begin() is never called 13 => 5490 12 => 5490 AgeLeft ListDump: - 16 => 10979 - 14 => 10979 - 17 => 7319 - 13 => 5489 + 16 => 10980 + 14 => 10980 + 17 => 7320 + 13 => 5490 12 => 5489 CurrentSpeed ListDump: 12 => 27 @@ -9583,4 +9586,23 @@ ERROR: IsEnd() is invalid as Begin() is never called -1 > 2147483647: false -2147483648 > 2147483647: false 13725 > -2147483648: true +--Valuate() with excessive CPU usage-- +Your script made an error: excessive CPU usage in valuator function + +*FUNCTION [unknown()] regression/main.nut line [2034] +*FUNCTION [Valuate()] NATIVE line [-1] +*FUNCTION [Start()] regression/main.nut line [2035] + +[id] 0 +[this] TABLE +[Infinite] CLOSURE +[list] INSTANCE +[this] INSTANCE +Your script made an error: excessive CPU usage in valuator function + +*FUNCTION [Start()] regression/main.nut line [2035] + +[Infinite] CLOSURE +[list] INSTANCE +[this] INSTANCE ERROR: The script died unexpectedly. diff --git a/regression/regression/test.sav b/regression/regression/test.sav index cf97052c..30b68c12 100644 Binary files a/regression/regression/test.sav and b/regression/regression/test.sav differ diff --git a/regression/stationlist/CMakeLists.txt b/regression/stationlist/CMakeLists.txt new file mode 100644 index 00000000..cfbc2cde --- /dev/null +++ b/regression/stationlist/CMakeLists.txt @@ -0,0 +1,7 @@ +include(CreateRegression) +create_regression( + ${CMAKE_CURRENT_SOURCE_DIR}/info.nut + ${CMAKE_CURRENT_SOURCE_DIR}/main.nut + ${CMAKE_CURRENT_SOURCE_DIR}/result.txt + ${CMAKE_CURRENT_SOURCE_DIR}/test.sav +) diff --git a/regression/stationlist/info.nut b/regression/stationlist/info.nut index 099a7d12..f3a16848 100644 --- a/regression/stationlist/info.nut +++ b/regression/stationlist/info.nut @@ -4,7 +4,7 @@ class StationList extends AIInfo { function GetShortName() { return "REGS"; } function GetDescription() { return "This runs stationlist-tests on some commands. On the same map the result should always be the same."; } function GetVersion() { return 1; } - function GetAPIVersion() { return "13"; } + function GetAPIVersion() { return "14"; } function GetDate() { return "2007-03-18"; } function CreateInstance() { return "StationList"; } function UseAsRandomAI() { return false; } diff --git a/regression/stationlist/result.txt b/regression/stationlist/result.txt index 20e59476..c04a3063 100644 --- a/regression/stationlist/result.txt +++ b/regression/stationlist/result.txt @@ -1,4 +1,3 @@ - --StationList-- Count(): 5 Location ListDump: diff --git a/src/3rdparty/CMakeLists.txt b/src/3rdparty/CMakeLists.txt index 50fa6922..4d17f023 100644 --- a/src/3rdparty/CMakeLists.txt +++ b/src/3rdparty/CMakeLists.txt @@ -1,5 +1,9 @@ +add_subdirectory(catch2) add_subdirectory(fmt) +add_subdirectory(icu) add_subdirectory(md5) +add_subdirectory(monocypher) add_subdirectory(squirrel) +add_subdirectory(nlohmann) add_subdirectory(opengl) -add_subdirectory(os2) +add_subdirectory(openttd_social_integration_api) diff --git a/src/3rdparty/README.licensing b/src/3rdparty/README.licensing index 112b02a0..c5da7bdd 100644 --- a/src/3rdparty/README.licensing +++ b/src/3rdparty/README.licensing @@ -1,3 +1,3 @@ The files in this directory are not licensed under the same terms as the -rest of OpenTTD. Licensing details can be found in OpenTTD's readme.txt +rest of OpenTTD. Licensing details can be found in OpenTTD's README.md and in this directory or subdirectories as well. diff --git a/src/3rdparty/catch2/CMakeLists.txt b/src/3rdparty/catch2/CMakeLists.txt new file mode 100644 index 00000000..72e0afa7 --- /dev/null +++ b/src/3rdparty/catch2/CMakeLists.txt @@ -0,0 +1,3 @@ +add_files( + catch.hpp +) diff --git a/src/3rdparty/catch2/LICENSE.txt b/src/3rdparty/catch2/LICENSE.txt new file mode 100644 index 00000000..36b7cd93 --- /dev/null +++ b/src/3rdparty/catch2/LICENSE.txt @@ -0,0 +1,23 @@ +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/src/3rdparty/catch2/catch.hpp b/src/3rdparty/catch2/catch.hpp new file mode 100644 index 00000000..109698a5 --- /dev/null +++ b/src/3rdparty/catch2/catch.hpp @@ -0,0 +1,17976 @@ +/* + * Catch v2.13.10 + * Generated: 2022-10-16 11:01:23.452308 + * ---------------------------------------------------------- + * This file has been merged from multiple headers. Please don't edit it directly + * Copyright (c) 2022 Two Blue Cubes Ltd. All rights reserved. + * + * Distributed under the Boost Software License, Version 1.0. (See accompanying + * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + */ +#ifndef TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED +#define TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED +// start catch.hpp + + +#define CATCH_VERSION_MAJOR 2 +#define CATCH_VERSION_MINOR 13 +#define CATCH_VERSION_PATCH 10 + +#ifdef __clang__ +# pragma clang system_header +#elif defined __GNUC__ +# pragma GCC system_header +#endif + +// start catch_suppress_warnings.h + +#ifdef __clang__ +# ifdef __ICC // icpc defines the __clang__ macro +# pragma warning(push) +# pragma warning(disable: 161 1682) +# else // __ICC +# pragma clang diagnostic push +# pragma clang diagnostic ignored "-Wpadded" +# pragma clang diagnostic ignored "-Wswitch-enum" +# pragma clang diagnostic ignored "-Wcovered-switch-default" +# endif +#elif defined __GNUC__ + // Because REQUIREs trigger GCC's -Wparentheses, and because still + // supported version of g++ have only buggy support for _Pragmas, + // Wparentheses have to be suppressed globally. +# pragma GCC diagnostic ignored "-Wparentheses" // See #674 for details + +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wunused-variable" +# pragma GCC diagnostic ignored "-Wpadded" +#endif +// end catch_suppress_warnings.h +#if defined(CATCH_CONFIG_MAIN) || defined(CATCH_CONFIG_RUNNER) +# define CATCH_IMPL +# define CATCH_CONFIG_ALL_PARTS +#endif + +// In the impl file, we want to have access to all parts of the headers +// Can also be used to sanely support PCHs +#if defined(CATCH_CONFIG_ALL_PARTS) +# define CATCH_CONFIG_EXTERNAL_INTERFACES +# if defined(CATCH_CONFIG_DISABLE_MATCHERS) +# undef CATCH_CONFIG_DISABLE_MATCHERS +# endif +# if !defined(CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER) +# define CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER +# endif +#endif + +#if !defined(CATCH_CONFIG_IMPL_ONLY) +// start catch_platform.h + +// See e.g.: +// https://opensource.apple.com/source/CarbonHeaders/CarbonHeaders-18.1/TargetConditionals.h.auto.html +#ifdef __APPLE__ +# include +# if (defined(TARGET_OS_OSX) && TARGET_OS_OSX == 1) || \ + (defined(TARGET_OS_MAC) && TARGET_OS_MAC == 1) +# define CATCH_PLATFORM_MAC +# elif (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE == 1) +# define CATCH_PLATFORM_IPHONE +# endif + +#elif defined(linux) || defined(__linux) || defined(__linux__) +# define CATCH_PLATFORM_LINUX + +#elif defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER) || defined(__MINGW32__) +# define CATCH_PLATFORM_WINDOWS +#endif + +// end catch_platform.h + +#ifdef CATCH_IMPL +# ifndef CLARA_CONFIG_MAIN +# define CLARA_CONFIG_MAIN_NOT_DEFINED +# define CLARA_CONFIG_MAIN +# endif +#endif + +// start catch_user_interfaces.h + +namespace Catch { + unsigned int rngSeed(); +} + +// end catch_user_interfaces.h +// start catch_tag_alias_autoregistrar.h + +// start catch_common.h + +// start catch_compiler_capabilities.h + +// Detect a number of compiler features - by compiler +// The following features are defined: +// +// CATCH_CONFIG_COUNTER : is the __COUNTER__ macro supported? +// CATCH_CONFIG_WINDOWS_SEH : is Windows SEH supported? +// CATCH_CONFIG_POSIX_SIGNALS : are POSIX signals supported? +// CATCH_CONFIG_DISABLE_EXCEPTIONS : Are exceptions enabled? +// **************** +// Note to maintainers: if new toggles are added please document them +// in configuration.md, too +// **************** + +// In general each macro has a _NO_ form +// (e.g. CATCH_CONFIG_NO_POSIX_SIGNALS) which disables the feature. +// Many features, at point of detection, define an _INTERNAL_ macro, so they +// can be combined, en-mass, with the _NO_ forms later. + +#ifdef __cplusplus + +# if (__cplusplus >= 201402L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L) +# define CATCH_CPP14_OR_GREATER +# endif + +# if (__cplusplus >= 201703L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L) +# define CATCH_CPP17_OR_GREATER +# endif + +#endif + +// Only GCC compiler should be used in this block, so other compilers trying to +// mask themselves as GCC should be ignored. +#if defined(__GNUC__) && !defined(__clang__) && !defined(__ICC) && !defined(__CUDACC__) && !defined(__LCC__) +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma( "GCC diagnostic push" ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION _Pragma( "GCC diagnostic pop" ) + +# define CATCH_INTERNAL_IGNORE_BUT_WARN(...) (void)__builtin_constant_p(__VA_ARGS__) + +#endif + +#if defined(__clang__) + +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma( "clang diagnostic push" ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION _Pragma( "clang diagnostic pop" ) + +// As of this writing, IBM XL's implementation of __builtin_constant_p has a bug +// which results in calls to destructors being emitted for each temporary, +// without a matching initialization. In practice, this can result in something +// like `std::string::~string` being called on an uninitialized value. +// +// For example, this code will likely segfault under IBM XL: +// ``` +// REQUIRE(std::string("12") + "34" == "1234") +// ``` +// +// Therefore, `CATCH_INTERNAL_IGNORE_BUT_WARN` is not implemented. +# if !defined(__ibmxl__) && !defined(__CUDACC__) +# define CATCH_INTERNAL_IGNORE_BUT_WARN(...) (void)__builtin_constant_p(__VA_ARGS__) /* NOLINT(cppcoreguidelines-pro-type-vararg, hicpp-vararg) */ +# endif + +# define CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wexit-time-destructors\"" ) \ + _Pragma( "clang diagnostic ignored \"-Wglobal-constructors\"") + +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wparentheses\"" ) + +# define CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wunused-variable\"" ) + +# define CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wgnu-zero-variadic-macro-arguments\"" ) + +# define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS \ + _Pragma( "clang diagnostic ignored \"-Wunused-template\"" ) + +#endif // __clang__ + +//////////////////////////////////////////////////////////////////////////////// +// Assume that non-Windows platforms support posix signals by default +#if !defined(CATCH_PLATFORM_WINDOWS) + #define CATCH_INTERNAL_CONFIG_POSIX_SIGNALS +#endif + +//////////////////////////////////////////////////////////////////////////////// +// We know some environments not to support full POSIX signals +#if defined(__CYGWIN__) || defined(__QNX__) || defined(__EMSCRIPTEN__) || defined(__DJGPP__) + #define CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS +#endif + +#ifdef __OS400__ +# define CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS +# define CATCH_CONFIG_COLOUR_NONE +#endif + +//////////////////////////////////////////////////////////////////////////////// +// Android somehow still does not support std::to_string +#if defined(__ANDROID__) +# define CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING +# define CATCH_INTERNAL_CONFIG_ANDROID_LOGWRITE +#endif + +//////////////////////////////////////////////////////////////////////////////// +// Not all Windows environments support SEH properly +#if defined(__MINGW32__) +# define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH +#endif + +//////////////////////////////////////////////////////////////////////////////// +// PS4 +#if defined(__ORBIS__) +# define CATCH_INTERNAL_CONFIG_NO_NEW_CAPTURE +#endif + +//////////////////////////////////////////////////////////////////////////////// +// Cygwin +#ifdef __CYGWIN__ + +// Required for some versions of Cygwin to declare gettimeofday +// see: http://stackoverflow.com/questions/36901803/gettimeofday-not-declared-in-this-scope-cygwin +# define _BSD_SOURCE +// some versions of cygwin (most) do not support std::to_string. Use the libstd check. +// https://gcc.gnu.org/onlinedocs/gcc-4.8.2/libstdc++/api/a01053_source.html line 2812-2813 +# if !((__cplusplus >= 201103L) && defined(_GLIBCXX_USE_C99) \ + && !defined(_GLIBCXX_HAVE_BROKEN_VSWPRINTF)) + +# define CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING + +# endif +#endif // __CYGWIN__ + +//////////////////////////////////////////////////////////////////////////////// +// Visual C++ +#if defined(_MSC_VER) + +// Universal Windows platform does not support SEH +// Or console colours (or console at all...) +# if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP) +# define CATCH_CONFIG_COLOUR_NONE +# else +# define CATCH_INTERNAL_CONFIG_WINDOWS_SEH +# endif + +# if !defined(__clang__) // Handle Clang masquerading for msvc + +// MSVC traditional preprocessor needs some workaround for __VA_ARGS__ +// _MSVC_TRADITIONAL == 0 means new conformant preprocessor +// _MSVC_TRADITIONAL == 1 means old traditional non-conformant preprocessor +# if !defined(_MSVC_TRADITIONAL) || (defined(_MSVC_TRADITIONAL) && _MSVC_TRADITIONAL) +# define CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +# endif // MSVC_TRADITIONAL + +// Only do this if we're not using clang on Windows, which uses `diagnostic push` & `diagnostic pop` +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION __pragma( warning(push) ) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION __pragma( warning(pop) ) +# endif // __clang__ + +#endif // _MSC_VER + +#if defined(_REENTRANT) || defined(_MSC_VER) +// Enable async processing, as -pthread is specified or no additional linking is required +# define CATCH_INTERNAL_CONFIG_USE_ASYNC +#endif // _MSC_VER + +//////////////////////////////////////////////////////////////////////////////// +// Check if we are compiled with -fno-exceptions or equivalent +#if defined(__EXCEPTIONS) || defined(__cpp_exceptions) || defined(_CPPUNWIND) +# define CATCH_INTERNAL_CONFIG_EXCEPTIONS_ENABLED +#endif + +//////////////////////////////////////////////////////////////////////////////// +// DJGPP +#ifdef __DJGPP__ +# define CATCH_INTERNAL_CONFIG_NO_WCHAR +#endif // __DJGPP__ + +//////////////////////////////////////////////////////////////////////////////// +// Embarcadero C++Build +#if defined(__BORLANDC__) + #define CATCH_INTERNAL_CONFIG_POLYFILL_ISNAN +#endif + +//////////////////////////////////////////////////////////////////////////////// + +// Use of __COUNTER__ is suppressed during code analysis in +// CLion/AppCode 2017.2.x and former, because __COUNTER__ is not properly +// handled by it. +// Otherwise all supported compilers support COUNTER macro, +// but user still might want to turn it off +#if ( !defined(__JETBRAINS_IDE__) || __JETBRAINS_IDE__ >= 20170300L ) + #define CATCH_INTERNAL_CONFIG_COUNTER +#endif + +//////////////////////////////////////////////////////////////////////////////// + +// RTX is a special version of Windows that is real time. +// This means that it is detected as Windows, but does not provide +// the same set of capabilities as real Windows does. +#if defined(UNDER_RTSS) || defined(RTX64_BUILD) + #define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH + #define CATCH_INTERNAL_CONFIG_NO_ASYNC + #define CATCH_CONFIG_COLOUR_NONE +#endif + +#if !defined(_GLIBCXX_USE_C99_MATH_TR1) +#define CATCH_INTERNAL_CONFIG_GLOBAL_NEXTAFTER +#endif + +// Various stdlib support checks that require __has_include +#if defined(__has_include) + // Check if string_view is available and usable + #if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # define CATCH_INTERNAL_CONFIG_CPP17_STRING_VIEW + #endif + + // Check if optional is available and usable + # if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # define CATCH_INTERNAL_CONFIG_CPP17_OPTIONAL + # endif // __has_include() && defined(CATCH_CPP17_OR_GREATER) + + // Check if byte is available and usable + # if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # include + # if defined(__cpp_lib_byte) && (__cpp_lib_byte > 0) + # define CATCH_INTERNAL_CONFIG_CPP17_BYTE + # endif + # endif // __has_include() && defined(CATCH_CPP17_OR_GREATER) + + // Check if variant is available and usable + # if __has_include() && defined(CATCH_CPP17_OR_GREATER) + # if defined(__clang__) && (__clang_major__ < 8) + // work around clang bug with libstdc++ https://bugs.llvm.org/show_bug.cgi?id=31852 + // fix should be in clang 8, workaround in libstdc++ 8.2 + # include + # if defined(__GLIBCXX__) && defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE < 9) + # define CATCH_CONFIG_NO_CPP17_VARIANT + # else + # define CATCH_INTERNAL_CONFIG_CPP17_VARIANT + # endif // defined(__GLIBCXX__) && defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE < 9) + # else + # define CATCH_INTERNAL_CONFIG_CPP17_VARIANT + # endif // defined(__clang__) && (__clang_major__ < 8) + # endif // __has_include() && defined(CATCH_CPP17_OR_GREATER) +#endif // defined(__has_include) + +#if defined(CATCH_INTERNAL_CONFIG_COUNTER) && !defined(CATCH_CONFIG_NO_COUNTER) && !defined(CATCH_CONFIG_COUNTER) +# define CATCH_CONFIG_COUNTER +#endif +#if defined(CATCH_INTERNAL_CONFIG_WINDOWS_SEH) && !defined(CATCH_CONFIG_NO_WINDOWS_SEH) && !defined(CATCH_CONFIG_WINDOWS_SEH) && !defined(CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH) +# define CATCH_CONFIG_WINDOWS_SEH +#endif +// This is set by default, because we assume that unix compilers are posix-signal-compatible by default. +#if defined(CATCH_INTERNAL_CONFIG_POSIX_SIGNALS) && !defined(CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS) && !defined(CATCH_CONFIG_NO_POSIX_SIGNALS) && !defined(CATCH_CONFIG_POSIX_SIGNALS) +# define CATCH_CONFIG_POSIX_SIGNALS +#endif +// This is set by default, because we assume that compilers with no wchar_t support are just rare exceptions. +#if !defined(CATCH_INTERNAL_CONFIG_NO_WCHAR) && !defined(CATCH_CONFIG_NO_WCHAR) && !defined(CATCH_CONFIG_WCHAR) +# define CATCH_CONFIG_WCHAR +#endif + +#if !defined(CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING) && !defined(CATCH_CONFIG_NO_CPP11_TO_STRING) && !defined(CATCH_CONFIG_CPP11_TO_STRING) +# define CATCH_CONFIG_CPP11_TO_STRING +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_OPTIONAL) && !defined(CATCH_CONFIG_NO_CPP17_OPTIONAL) && !defined(CATCH_CONFIG_CPP17_OPTIONAL) +# define CATCH_CONFIG_CPP17_OPTIONAL +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_STRING_VIEW) && !defined(CATCH_CONFIG_NO_CPP17_STRING_VIEW) && !defined(CATCH_CONFIG_CPP17_STRING_VIEW) +# define CATCH_CONFIG_CPP17_STRING_VIEW +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_VARIANT) && !defined(CATCH_CONFIG_NO_CPP17_VARIANT) && !defined(CATCH_CONFIG_CPP17_VARIANT) +# define CATCH_CONFIG_CPP17_VARIANT +#endif + +#if defined(CATCH_INTERNAL_CONFIG_CPP17_BYTE) && !defined(CATCH_CONFIG_NO_CPP17_BYTE) && !defined(CATCH_CONFIG_CPP17_BYTE) +# define CATCH_CONFIG_CPP17_BYTE +#endif + +#if defined(CATCH_CONFIG_EXPERIMENTAL_REDIRECT) +# define CATCH_INTERNAL_CONFIG_NEW_CAPTURE +#endif + +#if defined(CATCH_INTERNAL_CONFIG_NEW_CAPTURE) && !defined(CATCH_INTERNAL_CONFIG_NO_NEW_CAPTURE) && !defined(CATCH_CONFIG_NO_NEW_CAPTURE) && !defined(CATCH_CONFIG_NEW_CAPTURE) +# define CATCH_CONFIG_NEW_CAPTURE +#endif + +#if !defined(CATCH_INTERNAL_CONFIG_EXCEPTIONS_ENABLED) && !defined(CATCH_CONFIG_DISABLE_EXCEPTIONS) +# define CATCH_CONFIG_DISABLE_EXCEPTIONS +#endif + +#if defined(CATCH_INTERNAL_CONFIG_POLYFILL_ISNAN) && !defined(CATCH_CONFIG_NO_POLYFILL_ISNAN) && !defined(CATCH_CONFIG_POLYFILL_ISNAN) +# define CATCH_CONFIG_POLYFILL_ISNAN +#endif + +#if defined(CATCH_INTERNAL_CONFIG_USE_ASYNC) && !defined(CATCH_INTERNAL_CONFIG_NO_ASYNC) && !defined(CATCH_CONFIG_NO_USE_ASYNC) && !defined(CATCH_CONFIG_USE_ASYNC) +# define CATCH_CONFIG_USE_ASYNC +#endif + +#if defined(CATCH_INTERNAL_CONFIG_ANDROID_LOGWRITE) && !defined(CATCH_CONFIG_NO_ANDROID_LOGWRITE) && !defined(CATCH_CONFIG_ANDROID_LOGWRITE) +# define CATCH_CONFIG_ANDROID_LOGWRITE +#endif + +#if defined(CATCH_INTERNAL_CONFIG_GLOBAL_NEXTAFTER) && !defined(CATCH_CONFIG_NO_GLOBAL_NEXTAFTER) && !defined(CATCH_CONFIG_GLOBAL_NEXTAFTER) +# define CATCH_CONFIG_GLOBAL_NEXTAFTER +#endif + +// Even if we do not think the compiler has that warning, we still have +// to provide a macro that can be used by the code. +#if !defined(CATCH_INTERNAL_START_WARNINGS_SUPPRESSION) +# define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION +#endif +#if !defined(CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION) +# define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS +#endif +#if !defined(CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS +#endif + +// The goal of this macro is to avoid evaluation of the arguments, but +// still have the compiler warn on problems inside... +#if !defined(CATCH_INTERNAL_IGNORE_BUT_WARN) +# define CATCH_INTERNAL_IGNORE_BUT_WARN(...) +#endif + +#if defined(__APPLE__) && defined(__apple_build_version__) && (__clang_major__ < 10) +# undef CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS +#elif defined(__clang__) && (__clang_major__ < 5) +# undef CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS +#endif + +#if !defined(CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS +#endif + +#if defined(CATCH_CONFIG_DISABLE_EXCEPTIONS) +#define CATCH_TRY if ((true)) +#define CATCH_CATCH_ALL if ((false)) +#define CATCH_CATCH_ANON(type) if ((false)) +#else +#define CATCH_TRY try +#define CATCH_CATCH_ALL catch (...) +#define CATCH_CATCH_ANON(type) catch (type) +#endif + +#if defined(CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR) && !defined(CATCH_CONFIG_NO_TRADITIONAL_MSVC_PREPROCESSOR) && !defined(CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR) +#define CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#endif + +// end catch_compiler_capabilities.h +#define INTERNAL_CATCH_UNIQUE_NAME_LINE2( name, line ) name##line +#define INTERNAL_CATCH_UNIQUE_NAME_LINE( name, line ) INTERNAL_CATCH_UNIQUE_NAME_LINE2( name, line ) +#ifdef CATCH_CONFIG_COUNTER +# define INTERNAL_CATCH_UNIQUE_NAME( name ) INTERNAL_CATCH_UNIQUE_NAME_LINE( name, __COUNTER__ ) +#else +# define INTERNAL_CATCH_UNIQUE_NAME( name ) INTERNAL_CATCH_UNIQUE_NAME_LINE( name, __LINE__ ) +#endif + +#include +#include +#include + +// We need a dummy global operator<< so we can bring it into Catch namespace later +struct Catch_global_namespace_dummy {}; +std::ostream& operator<<(std::ostream&, Catch_global_namespace_dummy); + +namespace Catch { + + struct CaseSensitive { enum Choice { + Yes, + No + }; }; + + class NonCopyable { + NonCopyable( NonCopyable const& ) = delete; + NonCopyable( NonCopyable && ) = delete; + NonCopyable& operator = ( NonCopyable const& ) = delete; + NonCopyable& operator = ( NonCopyable && ) = delete; + + protected: + NonCopyable(); + virtual ~NonCopyable(); + }; + + struct SourceLineInfo { + + SourceLineInfo() = delete; + SourceLineInfo( char const* _file, std::size_t _line ) noexcept + : file( _file ), + line( _line ) + {} + + SourceLineInfo( SourceLineInfo const& other ) = default; + SourceLineInfo& operator = ( SourceLineInfo const& ) = default; + SourceLineInfo( SourceLineInfo&& ) noexcept = default; + SourceLineInfo& operator = ( SourceLineInfo&& ) noexcept = default; + + bool empty() const noexcept { return file[0] == '\0'; } + bool operator == ( SourceLineInfo const& other ) const noexcept; + bool operator < ( SourceLineInfo const& other ) const noexcept; + + char const* file; + std::size_t line; + }; + + std::ostream& operator << ( std::ostream& os, SourceLineInfo const& info ); + + // Bring in operator<< from global namespace into Catch namespace + // This is necessary because the overload of operator<< above makes + // lookup stop at namespace Catch + using ::operator<<; + + // Use this in variadic streaming macros to allow + // >> +StreamEndStop + // as well as + // >> stuff +StreamEndStop + struct StreamEndStop { + std::string operator+() const; + }; + template + T const& operator + ( T const& value, StreamEndStop ) { + return value; + } +} + +#define CATCH_INTERNAL_LINEINFO \ + ::Catch::SourceLineInfo( __FILE__, static_cast( __LINE__ ) ) + +// end catch_common.h +namespace Catch { + + struct RegistrarForTagAliases { + RegistrarForTagAliases( char const* alias, char const* tag, SourceLineInfo const& lineInfo ); + }; + +} // end namespace Catch + +#define CATCH_REGISTER_TAG_ALIAS( alias, spec ) \ + CATCH_INTERNAL_START_WARNINGS_SUPPRESSION \ + CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS \ + namespace{ Catch::RegistrarForTagAliases INTERNAL_CATCH_UNIQUE_NAME( AutoRegisterTagAlias )( alias, spec, CATCH_INTERNAL_LINEINFO ); } \ + CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION + +// end catch_tag_alias_autoregistrar.h +// start catch_test_registry.h + +// start catch_interfaces_testcase.h + +#include + +namespace Catch { + + class TestSpec; + + struct ITestInvoker { + virtual void invoke () const = 0; + virtual ~ITestInvoker(); + }; + + class TestCase; + struct IConfig; + + struct ITestCaseRegistry { + virtual ~ITestCaseRegistry(); + virtual std::vector const& getAllTests() const = 0; + virtual std::vector const& getAllTestsSorted( IConfig const& config ) const = 0; + }; + + bool isThrowSafe( TestCase const& testCase, IConfig const& config ); + bool matchTest( TestCase const& testCase, TestSpec const& testSpec, IConfig const& config ); + std::vector filterTests( std::vector const& testCases, TestSpec const& testSpec, IConfig const& config ); + std::vector const& getAllTestCasesSorted( IConfig const& config ); + +} + +// end catch_interfaces_testcase.h +// start catch_stringref.h + +#include +#include +#include +#include + +namespace Catch { + + /// A non-owning string class (similar to the forthcoming std::string_view) + /// Note that, because a StringRef may be a substring of another string, + /// it may not be null terminated. + class StringRef { + public: + using size_type = std::size_t; + using const_iterator = const char*; + + private: + static constexpr char const* const s_empty = ""; + + char const* m_start = s_empty; + size_type m_size = 0; + + public: // construction + constexpr StringRef() noexcept = default; + + StringRef( char const* rawChars ) noexcept; + + constexpr StringRef( char const* rawChars, size_type size ) noexcept + : m_start( rawChars ), + m_size( size ) + {} + + StringRef( std::string const& stdString ) noexcept + : m_start( stdString.c_str() ), + m_size( stdString.size() ) + {} + + explicit operator std::string() const { + return std::string(m_start, m_size); + } + + public: // operators + auto operator == ( StringRef const& other ) const noexcept -> bool; + auto operator != (StringRef const& other) const noexcept -> bool { + return !(*this == other); + } + + auto operator[] ( size_type index ) const noexcept -> char { + assert(index < m_size); + return m_start[index]; + } + + public: // named queries + constexpr auto empty() const noexcept -> bool { + return m_size == 0; + } + constexpr auto size() const noexcept -> size_type { + return m_size; + } + + // Returns the current start pointer. If the StringRef is not + // null-terminated, throws std::domain_exception + auto c_str() const -> char const*; + + public: // substrings and searches + // Returns a substring of [start, start + length). + // If start + length > size(), then the substring is [start, size()). + // If start > size(), then the substring is empty. + auto substr( size_type start, size_type length ) const noexcept -> StringRef; + + // Returns the current start pointer. May not be null-terminated. + auto data() const noexcept -> char const*; + + constexpr auto isNullTerminated() const noexcept -> bool { + return m_start[m_size] == '\0'; + } + + public: // iterators + constexpr const_iterator begin() const { return m_start; } + constexpr const_iterator end() const { return m_start + m_size; } + }; + + auto operator += ( std::string& lhs, StringRef const& sr ) -> std::string&; + auto operator << ( std::ostream& os, StringRef const& sr ) -> std::ostream&; + + constexpr auto operator "" _sr( char const* rawChars, std::size_t size ) noexcept -> StringRef { + return StringRef( rawChars, size ); + } +} // namespace Catch + +constexpr auto operator "" _catch_sr( char const* rawChars, std::size_t size ) noexcept -> Catch::StringRef { + return Catch::StringRef( rawChars, size ); +} + +// end catch_stringref.h +// start catch_preprocessor.hpp + + +#define CATCH_RECURSION_LEVEL0(...) __VA_ARGS__ +#define CATCH_RECURSION_LEVEL1(...) CATCH_RECURSION_LEVEL0(CATCH_RECURSION_LEVEL0(CATCH_RECURSION_LEVEL0(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL2(...) CATCH_RECURSION_LEVEL1(CATCH_RECURSION_LEVEL1(CATCH_RECURSION_LEVEL1(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL3(...) CATCH_RECURSION_LEVEL2(CATCH_RECURSION_LEVEL2(CATCH_RECURSION_LEVEL2(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL4(...) CATCH_RECURSION_LEVEL3(CATCH_RECURSION_LEVEL3(CATCH_RECURSION_LEVEL3(__VA_ARGS__))) +#define CATCH_RECURSION_LEVEL5(...) CATCH_RECURSION_LEVEL4(CATCH_RECURSION_LEVEL4(CATCH_RECURSION_LEVEL4(__VA_ARGS__))) + +#ifdef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#define INTERNAL_CATCH_EXPAND_VARGS(...) __VA_ARGS__ +// MSVC needs more evaluations +#define CATCH_RECURSION_LEVEL6(...) CATCH_RECURSION_LEVEL5(CATCH_RECURSION_LEVEL5(CATCH_RECURSION_LEVEL5(__VA_ARGS__))) +#define CATCH_RECURSE(...) CATCH_RECURSION_LEVEL6(CATCH_RECURSION_LEVEL6(__VA_ARGS__)) +#else +#define CATCH_RECURSE(...) CATCH_RECURSION_LEVEL5(__VA_ARGS__) +#endif + +#define CATCH_REC_END(...) +#define CATCH_REC_OUT + +#define CATCH_EMPTY() +#define CATCH_DEFER(id) id CATCH_EMPTY() + +#define CATCH_REC_GET_END2() 0, CATCH_REC_END +#define CATCH_REC_GET_END1(...) CATCH_REC_GET_END2 +#define CATCH_REC_GET_END(...) CATCH_REC_GET_END1 +#define CATCH_REC_NEXT0(test, next, ...) next CATCH_REC_OUT +#define CATCH_REC_NEXT1(test, next) CATCH_DEFER ( CATCH_REC_NEXT0 ) ( test, next, 0) +#define CATCH_REC_NEXT(test, next) CATCH_REC_NEXT1(CATCH_REC_GET_END test, next) + +#define CATCH_REC_LIST0(f, x, peek, ...) , f(x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1) ) ( f, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST1(f, x, peek, ...) , f(x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST0) ) ( f, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST2(f, x, peek, ...) f(x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1) ) ( f, peek, __VA_ARGS__ ) + +#define CATCH_REC_LIST0_UD(f, userdata, x, peek, ...) , f(userdata, x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1_UD) ) ( f, userdata, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST1_UD(f, userdata, x, peek, ...) , f(userdata, x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST0_UD) ) ( f, userdata, peek, __VA_ARGS__ ) +#define CATCH_REC_LIST2_UD(f, userdata, x, peek, ...) f(userdata, x) CATCH_DEFER ( CATCH_REC_NEXT(peek, CATCH_REC_LIST1_UD) ) ( f, userdata, peek, __VA_ARGS__ ) + +// Applies the function macro `f` to each of the remaining parameters, inserts commas between the results, +// and passes userdata as the first parameter to each invocation, +// e.g. CATCH_REC_LIST_UD(f, x, a, b, c) evaluates to f(x, a), f(x, b), f(x, c) +#define CATCH_REC_LIST_UD(f, userdata, ...) CATCH_RECURSE(CATCH_REC_LIST2_UD(f, userdata, __VA_ARGS__, ()()(), ()()(), ()()(), 0)) + +#define CATCH_REC_LIST(f, ...) CATCH_RECURSE(CATCH_REC_LIST2(f, __VA_ARGS__, ()()(), ()()(), ()()(), 0)) + +#define INTERNAL_CATCH_EXPAND1(param) INTERNAL_CATCH_EXPAND2(param) +#define INTERNAL_CATCH_EXPAND2(...) INTERNAL_CATCH_NO## __VA_ARGS__ +#define INTERNAL_CATCH_DEF(...) INTERNAL_CATCH_DEF __VA_ARGS__ +#define INTERNAL_CATCH_NOINTERNAL_CATCH_DEF +#define INTERNAL_CATCH_STRINGIZE(...) INTERNAL_CATCH_STRINGIZE2(__VA_ARGS__) +#ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#define INTERNAL_CATCH_STRINGIZE2(...) #__VA_ARGS__ +#define INTERNAL_CATCH_STRINGIZE_WITHOUT_PARENS(param) INTERNAL_CATCH_STRINGIZE(INTERNAL_CATCH_REMOVE_PARENS(param)) +#else +// MSVC is adding extra space and needs another indirection to expand INTERNAL_CATCH_NOINTERNAL_CATCH_DEF +#define INTERNAL_CATCH_STRINGIZE2(...) INTERNAL_CATCH_STRINGIZE3(__VA_ARGS__) +#define INTERNAL_CATCH_STRINGIZE3(...) #__VA_ARGS__ +#define INTERNAL_CATCH_STRINGIZE_WITHOUT_PARENS(param) (INTERNAL_CATCH_STRINGIZE(INTERNAL_CATCH_REMOVE_PARENS(param)) + 1) +#endif + +#define INTERNAL_CATCH_MAKE_NAMESPACE2(...) ns_##__VA_ARGS__ +#define INTERNAL_CATCH_MAKE_NAMESPACE(name) INTERNAL_CATCH_MAKE_NAMESPACE2(name) + +#define INTERNAL_CATCH_REMOVE_PARENS(...) INTERNAL_CATCH_EXPAND1(INTERNAL_CATCH_DEF __VA_ARGS__) + +#ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR +#define INTERNAL_CATCH_MAKE_TYPE_LIST2(...) decltype(get_wrapper()) +#define INTERNAL_CATCH_MAKE_TYPE_LIST(...) INTERNAL_CATCH_MAKE_TYPE_LIST2(INTERNAL_CATCH_REMOVE_PARENS(__VA_ARGS__)) +#else +#define INTERNAL_CATCH_MAKE_TYPE_LIST2(...) INTERNAL_CATCH_EXPAND_VARGS(decltype(get_wrapper())) +#define INTERNAL_CATCH_MAKE_TYPE_LIST(...) INTERNAL_CATCH_EXPAND_VARGS(INTERNAL_CATCH_MAKE_TYPE_LIST2(INTERNAL_CATCH_REMOVE_PARENS(__VA_ARGS__))) +#endif + +#define INTERNAL_CATCH_MAKE_TYPE_LISTS_FROM_TYPES(...)\ + CATCH_REC_LIST(INTERNAL_CATCH_MAKE_TYPE_LIST,__VA_ARGS__) + +#define INTERNAL_CATCH_REMOVE_PARENS_1_ARG(_0) INTERNAL_CATCH_REMOVE_PARENS(_0) +#define INTERNAL_CATCH_REMOVE_PARENS_2_ARG(_0, _1) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_1_ARG(_1) +#define INTERNAL_CATCH_REMOVE_PARENS_3_ARG(_0, _1, _2) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_2_ARG(_1, _2) +#define INTERNAL_CATCH_REMOVE_PARENS_4_ARG(_0, _1, _2, _3) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_3_ARG(_1, _2, _3) +#define INTERNAL_CATCH_REMOVE_PARENS_5_ARG(_0, _1, _2, _3, _4) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_4_ARG(_1, _2, _3, _4) +#define INTERNAL_CATCH_REMOVE_PARENS_6_ARG(_0, _1, _2, _3, _4, _5) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_5_ARG(_1, _2, _3, _4, _5) +#define INTERNAL_CATCH_REMOVE_PARENS_7_ARG(_0, _1, _2, _3, _4, _5, _6) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_6_ARG(_1, _2, _3, _4, _5, _6) +#define INTERNAL_CATCH_REMOVE_PARENS_8_ARG(_0, _1, _2, _3, _4, _5, _6, _7) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_7_ARG(_1, _2, _3, _4, _5, _6, _7) +#define INTERNAL_CATCH_REMOVE_PARENS_9_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_8_ARG(_1, _2, _3, _4, _5, _6, _7, _8) +#define INTERNAL_CATCH_REMOVE_PARENS_10_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_9_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9) +#define INTERNAL_CATCH_REMOVE_PARENS_11_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10) INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_10_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10) + +#define INTERNAL_CATCH_VA_NARGS_IMPL(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, N, ...) N + +#define INTERNAL_CATCH_TYPE_GEN\ + template struct TypeList {};\ + template\ + constexpr auto get_wrapper() noexcept -> TypeList { return {}; }\ + template class...> struct TemplateTypeList{};\ + template class...Cs>\ + constexpr auto get_wrapper() noexcept -> TemplateTypeList { return {}; }\ + template\ + struct append;\ + template\ + struct rewrap;\ + template class, typename...>\ + struct create;\ + template class, typename>\ + struct convert;\ + \ + template \ + struct append { using type = T; };\ + template< template class L1, typename...E1, template class L2, typename...E2, typename...Rest>\ + struct append, L2, Rest...> { using type = typename append, Rest...>::type; };\ + template< template class L1, typename...E1, typename...Rest>\ + struct append, TypeList, Rest...> { using type = L1; };\ + \ + template< template class Container, template class List, typename...elems>\ + struct rewrap, List> { using type = TypeList>; };\ + template< template class Container, template class List, class...Elems, typename...Elements>\ + struct rewrap, List, Elements...> { using type = typename append>, typename rewrap, Elements...>::type>::type; };\ + \ + template