2403 std

.github/workflows/run-tests.yml

@@ -0,0 +1,102 @@
+#
+# CI for running tests
+#
+
+on: [push, pull_request]
+name: Automated Tests
+
+jobs:
+  run-tests-asan-ubsan:
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Install dependencies
+      run: |
+        sudo apt-get -y update
+        sudo apt-get -ym install libbz2-dev zlib1g-dev libpng-dev autoconf clang-14 ccache moreutils
+    - name: Cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.ccache
+        key: ccache:${{ github.job }}:${{ github.ref }}:${{ github.sha }}
+        restore-keys: |
+          ccache:${{ github.job }}:${{ github.ref }}
+          ccache:${{ github.job }}
+    - name: Configure Simutrans Build
+      run: |
+        autoconf
+        CC="ccache clang-14" CXX="ccache clang++-14" ./configure
+        echo "FLAGS += -fsanitize=address,undefined -fno-sanitize-recover=all -fno-sanitize=shift,function" >> config.default
+        echo "LDFLAGS += -fsanitize=address,undefined" >> config.default
+    - name: Build Simutrans
+      run: |
+        CC="ccache clang-14" CXX="ccache clang++-14" make -j$(nproc)
+    - name: Install pak128.britain-ex-nightly
+      run: |
+        pushd simutrans
+        printf '2\ni\ny\n' | ../get_pak.sh
+        popd
+    - name: Link tests as scenario
+      run: |
+        mkdir -p ./simutrans/pak128.britain-ex-nightly/scenario
+        ln -sT $GITHUB_WORKSPACE/tests ./simutrans/pak128.britain-ex-nightly/scenario/automated-tests
+    - name: Create simuconf
+      run: |
+        mkdir -p ~/simutrans/
+        echo "frames_per_second = 100"              >> ~/simutrans/simuconf.tab
+        echo "fast_forward_frames_per_second = 100" >> ~/simutrans/simuconf.tab
+    - name: Run tests
+      run: |
+        export ASAN_OPTIONS="print_stacktrace=1 abort_on_error=1 detect_leaks=0"
+        export UBSAN_OPTIONS="print_stacktrace=1 abort_on_error=1"
+        cp scripts/run-automated-tests.sh .
+        chmod +x run-automated-tests.sh
+        timeout 10m ./run-automated-tests.sh # 10 minutes ought to be enough for anybody.
+
+  run-tests-tsan:
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Install dependencies
+      run: |
+        sudo apt-get -y update
+        sudo apt-get -ym install libbz2-dev zlib1g-dev libpng-dev autoconf clang-14 ccache moreutils
+    - name: Cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.ccache
+        key: ccache:${{ github.job }}:${{ github.ref }}:${{ github.sha }}
+        restore-keys: |
+          ccache:${{ github.job }}:${{ github.ref }}
+          ccache:${{ github.job }}
+    - name: Configure Simutrans Build
+      run: |
+        autoconf
+        CC="ccache clang-14" CXX="ccache clang++-14" ./configure
+        echo "FLAGS   += -fsanitize=thread" >> config.default
+        echo "LDFLAGS += -fsanitize=thread" >> config.default
+    - name: Build Simutrans
+      run: |
+        CC="ccache clang-14" CXX="ccache clang++-14" make -j$(nproc)
+    - name: Install pak128.britain-ex-nightly
+      run: |
+        pushd simutrans
+        printf '2\ni\ny\n' | ../get_pak.sh
+        popd
+    - name: Link tests as scenario
+      run: |
+        mkdir -p ./simutrans/pak128.britain-ex-nightly/scenario
+        ln -sT $GITHUB_WORKSPACE/tests ./simutrans/pak128.britain-ex-nightly/scenario/automated-tests
+    - name: Create simuconf
+      run: |
+        mkdir -p ~/simutrans/
+        echo "frames_per_second = 100"              >> ~/simutrans/simuconf.tab
+        echo "fast_forward_frames_per_second = 100" >> ~/simutrans/simuconf.tab
+    - name: Run tests
+      run: |
+        export TSAN_OPTIONS="print_stacktrace=1 second_deadlock_stack=1 history_size=7 verbose=2"
+        cp scripts/run-automated-tests.sh .
+        chmod +x run-automated-tests.sh
+        timeout 10m ./run-automated-tests.sh # 10 minutes ought to be enough for anybody.

.gitignore

@@ -179,7 +179,6 @@ text/zh
 
 
 # Folders:
-script/
 pak*/
 text/citylists/
 

CMakeLists.txt

@@ -21,8 +21,8 @@ project(simutrans-extended LANGUAGES C CXX)
 
 include(SimutransCommitInfo)
 
-# Force C++11 everywhere
-set(CMAKE_CXX_STANDARD 11)
+# Force C++14 everywhere
+set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
@@ -306,6 +306,23 @@ if (APPLE)
 endif (APPLE)
 
 
+
+#
+# Tests
+#
+add_custom_target(test
+	$<TARGET_FILE:simutrans-extended>
+		-use_workdir
+		-objects pak128.britain-ex-nightly
+		-scenario automated-tests
+		-debug 2
+		-lang en
+		-fps 100
+	DEPENDS simutrans
+	WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/simutrans
+)
+
+
 #
 # Installation
 #

Makefile

@@ -72,7 +72,7 @@ else
 endif
 
 ifeq ($(OSTYPE),mac)
-  CFLAGS +=  -std=c++11 -stdlib=libc++
+  CFLAGS  += -stdlib=libc++
   LDFLAGS += -stdlib=libc++
 endif
 
@@ -84,13 +84,9 @@ else
   SOURCES += sys/clipboard_internal.cc
 endif
 
-ifeq ($(OSTYPE),openbsd)
-  CXXFLAGS +=  -std=c++11
-endif
-
 LIBS += -lbz2 -lz -lpng
 
-CXXFLAGS +=  -std=gnu++11
+CXXFLAGS += -std=c++14
 
 ifneq ($(OSTYPE),mingw)
  LIBS += -lbz2 -lz
@@ -533,6 +529,7 @@ SOURCES += script/api_class.cc
 SOURCES += script/api_function.cc
 SOURCES += script/api_param.cc
 SOURCES += script/api/api_city.cc
+SOURCES += script/api/api_command.cc
 SOURCES += script/api/api_const.cc
 SOURCES += script/api/api_control.cc
 SOURCES += script/api/api_convoy.cc
@@ -544,6 +541,7 @@ SOURCES += script/api/api_line.cc
 SOURCES += script/api/api_map_objects.cc
 SOURCES += script/api/api_obj_desc.cc
 SOURCES += script/api/api_obj_desc_base.cc
+SOURCES += script/api/api_pathfinding.cc
 SOURCES += script/api/api_player.cc
 SOURCES += script/api/api_scenario.cc
 SOURCES += script/api/api_schedule.cc
@@ -556,6 +554,7 @@ SOURCES += script/api/get_next.cc
 SOURCES += script/dynamic_string.cc
 SOURCES += script/export_objs.cc
 SOURCES += script/script.cc
+SOURCES += script/script_loader.cc
 SOURCES += squirrel/sq_extensions.cc
 SOURCES += squirrel/squirrel/sqapi.cc
 SOURCES += squirrel/squirrel/sqclass.cc
@@ -792,3 +791,6 @@ makeobj:
 
 nettool:
 	$(Q)$(MAKE) -e -C nettools FLAGS="$(FLAGS)"
+test: simutrans
+	$(BUILDDIR)/$(PROG) -set_workdir $(shell pwd)/simutrans -objects pak -scenario automated-tests -debug 2 -lang en -fps 100
+

Simutrans-Extended.vcxproj

@@ -2106,6 +2106,7 @@
     <ClCompile Include="descriptor\reader\building_reader.cc" />
     <ClCompile Include="player\finance.cc" />
     <ClCompile Include="script\api\api_city.cc" />
+    <ClCompile Include="script\api\api_command.cc" />
     <ClCompile Include="script\api\api_const.cc" />
     <ClCompile Include="script\api\api_control.cc" />
     <ClCompile Include="script\api\api_convoy.cc" />
@@ -2115,8 +2116,9 @@
     <ClCompile Include="script\api\api_include.cc" />
     <ClCompile Include="script\api\api_line.cc" />
     <ClCompile Include="script\api\api_map_objects.cc" />
-    <ClCompile Include="script\api\api_obj_desc.cc" />
     <ClCompile Include="script\api\api_obj_desc_base.cc" />
+    <ClCompile Include="script\api\api_obj_desc.cc" />
+    <ClCompile Include="script\api\api_pathfinding.cc" />
     <ClCompile Include="script\api\api_player.cc" />
     <ClCompile Include="script\api\api_scenario.cc" />
     <ClCompile Include="script\api\api_schedule.cc" />
@@ -2132,6 +2134,7 @@
     <ClCompile Include="script\dynamic_string.cc" />
     <ClCompile Include="script\export_objs.cc" />
     <ClCompile Include="script\script.cc" />
+    <ClCompile Include="script\script_loader.cc" />
     <ClCompile Include="siminteraction.cc" />
     <ClCompile Include="simloadingscreen.cc" />
     <ClCompile Include="simsignalbox.cc" />

bauer/brueckenbauer.cc

@@ -164,14 +164,28 @@ void bridge_builder_t::fill_menu(tool_selector_t *tool_selector, const waytype_t
 	}
 
 	// now sorted ...
-	FOR(vector_tpl<bridge_desc_t const*>, const i, matching) {
+	for (bridge_desc_t const* const i : matching) {
 		tool_selector->add_tool_selector(i->get_builder());
 	}
 }
 
 
+const vector_tpl<const bridge_desc_t *>&  bridge_builder_t::get_available_bridges(const waytype_t wtyp)
+{
+	static vector_tpl<const bridge_desc_t *> dummy;
+	dummy.clear();
+	const uint16 time = welt->get_timeline_year_month();
+	for(auto const& i : desc_table) {
+		bridge_desc_t const* const b = i.value;
+		if (  b->get_waytype()==wtyp  &&  b->is_available(time)  ) {
+			dummy.append(b);
+		}
+	}
+	return dummy;
+}
+
 
-inline bool ribi_check( ribi_t::ribi ribi, ribi_t::ribi check_ribi )
+static inline bool ribi_check( ribi_t::ribi ribi, ribi_t::ribi check_ribi )
 {
 	// either check for single (if nothing given) otherwise ensure exact match
 	return check_ribi ? ribi == check_ribi : ribi_t::is_single( ribi );

bauer/brueckenbauer.h

@@ -155,6 +155,11 @@ class bridge_builder_t {
 	 * @param wtyp way type
 	 */
 	static void fill_menu(tool_selector_t *tool_selector, const waytype_t wtyp, sint16 sound_ok);
+
+	/**
+	 * Returns a list with available bridge types.
+	 */
+	static const vector_tpl<const bridge_desc_t *>& get_available_bridges(const waytype_t wtyp);
 };
 
 #endif

bauer/fabrikbauer.cc

@@ -81,7 +81,7 @@ void init_fab_map( karte_t *welt )
 	for( int i=0;  i<fab_map_w*welt->get_size().y;  i++ ) {
 		fab_map[i] = 0;
 	}
-	FOR(vector_tpl<fabrik_t*>, const f, welt->get_fab_list()) {
+	for(fabrik_t* const f : welt->get_fab_list()) {
 		add_factory_to_fab_map(welt, f);
 	}
 	if(  welt->get_settings().get_max_factory_spacing_percent()  ) {
@@ -94,7 +94,7 @@ void init_fab_map( karte_t *welt )
 
 
 /**
- * @param x,y world position
+ * @param x,y world position, needs to be valid coordinates
  * @returns true, if factory coordinate
  */
 inline bool is_factory_at(sint16 x, sint16 y)
@@ -431,7 +431,7 @@ class ocean_test_driver_t : public test_driver_t
 	bool check_next_tile(const grund_t* gr) const OVERRIDE { return gr->is_water(); };
 	ribi_t::ribi get_ribi(const grund_t* gr) const OVERRIDE { return gr->get_weg_ribi_unmasked(water_wt); };
 	waytype_t get_waytype() const OVERRIDE { return water_wt; }; // To trigger jps "jump" behavior; otherwise use invalid_wt
-	int get_cost(const grund_t *, const sint32, koord) OVERRIDE { return 1; };
+	int get_cost(const grund_t *, const sint32, ribi_t::ribi) OVERRIDE { return 1; };
 	bool is_target(const grund_t *, const grund_t *) OVERRIDE { return false; }; // unused
 };
 
@@ -966,8 +966,7 @@ int factory_builder_t::build_chain_link(const fabrik_t* origin_fab, const factor
 		weighted_vector_tpl<const factory_desc_t*>producer;
 		find_producer(producer, ware, welt->get_timeline_year_month());
 		bool local_supplier_unavailable = true;
-		FOR(weighted_vector_tpl<const factory_desc_t*>, producer_type, producer)
-		{
+		for(const factory_desc_t* producer_type : producer) {
 			if (producer_type->get_building()->is_allowed_region(origin_region))
 			{
 				local_supplier_unavailable = false;
@@ -1177,8 +1176,7 @@ int factory_builder_t::build_chain_link(const fabrik_t* origin_fab, const factor
 		/* now the cross-connect part:
 		 * connect also the factories we stole from before ...
 		 */
-		FOR(slist_tpl<fabrik_t*>, const fab, new_factories)
-		{
+		for(fabrik_t* const fab : new_factories) {
 			for(slist_tpl<factories_to_crossconnect_t>::iterator fabs_to_correct = factories_to_correct.begin(), end = factories_to_correct.end(); fabs_to_correct != end;)
 			{
 				fabs_to_correct->demand -= 1;

bauer/goods_manager.cc

@@ -98,15 +98,15 @@ bool goods_manager_t::successfully_loaded()
 	// now assign unique category indices for unique categories
 	max_catg_index = 0;
 	// first assign special freight (which always needs an own category)
-	FOR(vector_tpl<goods_desc_t*>, const i, goods) {
+	for(goods_desc_t* const i : goods) {
 		if (i->get_catg() == 0) {
 			i->catg_index = max_catg_index++;
 		}
 	}
 	// mapping of waren_t::catg to catg_index, map[catg] = catg_index
 	uint8 map[255] = {0};
 
-	FOR(vector_tpl<goods_desc_t*>, const i, goods) {
+	for(goods_desc_t* const i : goods) {
 		uint8 const catg = i->get_catg();
 		if(  catg > 0  ) {
 			if(  map[catg] == 0  ) { // We didn't found this category yet -> just create new index.