Merge branch 'main' into sin_support_ericw

# Conflicts:
#	common/bspfile_generic.cc
#	common/bspfile_q1.cc
#	common/bspfile_q2.cc
#	common/bspinfo.cc
#	common/decompile.cc
#	include/common/bspfile_generic.hh
#	include/common/bspfile_q1.hh
#	include/common/bspfile_q2.hh

Author: ericwa

README.md

@@ -43,21 +43,28 @@ source code.
 
 Dependencies: Embree 3.0+, TBB (TODO: version?), Sphinx (for building manuals)
 
-### Ubuntu
+### Ubuntu 24.04
 
 NOTE: Builds using Ubuntu's embree packages produce a significantly slower `light` (i.e. over twice as slow) than ones released on Embree's GitHub. See `build-linux-64.sh` for a better method. 
 
 ```
-sudo apt install libembree-dev libtbb-dev cmake build-essential g++
-sudo apt install python3-pip
-python3 -m pip install sphinx_rtd_theme
-export PATH="~/.local/bin/:$PATH"
+sudo apt update
+sudo apt install libembree-dev libtbb-dev cmake build-essential g++ qt6-base-dev
 git clone --recursive https://github.com/ericwa/ericw-tools
 cd ericw-tools
 mkdir build
 cd build
-cmake ..
-make
+cmake .. -DCMAKE_BUILD_TYPE=Release
+make -j 8
+
+# run tests
+./tests/tests
+
+# print qbsp help
+./qbsp/qbsp --help
+
+# launch lightpreview gui
+./lightpreview/lightpreview
 ```
 
 ### Windows
@@ -104,7 +111,7 @@ git clone --recursive https://github.com/ericwa/ericw-tools
 cd ericw-tools
 mkdir build
 cd build
-cmake .. -DCMAKE_PREFIX_PATH="$(brew --prefix embree);$(brew --prefix tbb)"
+cmake .. -DCMAKE_PREFIX_PATH="$(brew --prefix embree);$(brew --prefix tbb)" -DCMAKE_BUILD_TYPE=Release
 make
 ```
 

bsputil/bsputil.cc

@@ -439,8 +439,8 @@ static void CheckBSPFile(const mbsp_t *bsp)
             logging::print("warning: face {} has edges out of range ({}..{} >= {})\n", i, face->firstedge,
                 face->firstedge + face->numedges - 1, bsp->dsurfedges.size());
 
-        for (int j = 0; j < 4; j++) {
-            used_lightstyles.insert(face->styles[j]);
+        for (uint8_t style : face->styles) {
+            used_lightstyles.insert(style);
         }
     }
 
@@ -825,12 +825,12 @@ static void ExportTextures(const fs::path &source, const gamedef_t *game, const
 {
     for (auto &tex : bsp.texinfo) {
         // temp, just for us
-        auto tex_name = (source.parent_path() / "textures" / tex.texture.data()).replace_extension(".tga");
+        auto tex_name = (source.parent_path() / "textures" / tex.texturename).replace_extension(".tga");
 
         if (tex_name.string().find_first_of(' ') != std::string::npos)
             continue;
 
-        auto swl_meta = std::get<0>(img::load_texture(tex.texture.data(), false, game, bsputil_options));
+        auto swl_meta = std::get<0>(img::load_texture(tex.texturename, false, game, bsputil_options));
 
         if (!swl_meta)
             continue;
@@ -1579,17 +1579,17 @@ int bsputil_main(int _argc, const char **_argv)
             std::set<std::string_view, natural_less> written;
 
             for (auto &tex : bsp.texinfo) {
-                if (written.find(std::string_view(tex.texture.data())) != written.end()) {
+                if (written.find(tex.texturename) != written.end()) {
                     continue;
                 }
 
                 if (tex.nexttexinfo != -1) {
                     auto &next = bsp.texinfo[tex.nexttexinfo];
 
-                    f << std::string_view(tex.texture.data()) << " date 0 anim " << std::string_view(next.texture.data()) << std::endl;
+                    f << tex.texturename << " date 0 anim " << next.texturename << std::endl;
                 }
 
-                written.insert(std::string_view(tex.texture.data()));
+                written.insert(tex.texturename);
             }
 
             f.close();

common/bspfile.cc

@@ -456,6 +456,12 @@ struct gamedef_q1_like_t : public gamedef_t
         static const auto palette = make_palette(palette_bytes);
         return palette;
     }
+
+    size_t max_lightmaps() const override
+    {
+        static constexpr size_t n = bsp29_dface_t().styles.size();
+        return n;
+    }
 };
 
 struct gamedef_h2_t : public gamedef_q1_like_t<GAME_HEXEN_II>
@@ -1031,6 +1037,12 @@ struct gamedef_q2_t : public gamedef_t
         static const auto palette = make_palette(palette_bytes);
         return palette;
     }
+
+    size_t max_lightmaps() const override
+    {
+        static constexpr size_t n = q2_dface_t().styles.size();
+        return n;
+    }
 };
 
 struct gamedef_sin_t : public gamedef_t
@@ -1390,6 +1402,12 @@ struct gamedef_sin_t : public gamedef_t
         static const std::vector<qvec3b> palette;
         return palette;
     }
+
+    size_t max_lightmaps() const override
+    {
+        static constexpr size_t n = sin_dface_t().styles.size();
+        return n;
+    }
 };
 
 // Game definitions, used for the bsp versions below

common/bspfile_generic.cc

@@ -254,17 +254,6 @@ void bsp2_dnode_t::stream_read(std::istream &s)
     s >= std::tie(planenum, children, mins, maxs, firstface, numfaces);
 }
 
-// mface_t
-
-void mface_t::stream_write(std::ostream &s) const
-{
-    s <= std::tie(planenum, side, firstedge, numedges, texinfo, styles, lightofs, lightinfo);
-}
-void mface_t::stream_read(std::istream &s)
-{
-    s >= std::tie(planenum, side, firstedge, numedges, texinfo, styles, lightofs, lightinfo);
-}
-
 // bsp2_dclipnode_t
 
 void bsp2_dclipnode_t::stream_write(std::ostream &s) const
@@ -321,18 +310,6 @@ void dbrush_t::stream_read(std::istream &s)
     s >= std::tie(firstside, numsides, contents);
 }
 
-// q2_dbrushside_qbism_t
-
-void q2_dbrushside_qbism_t::stream_write(std::ostream &s) const
-{
-    s <= std::tie(planenum, texinfo, lightinfo);
-}
-
-void q2_dbrushside_qbism_t::stream_read(std::istream &s)
-{
-    s >= std::tie(planenum, texinfo, lightinfo);
-}
-
 // mbsp_t
 
 int mbsp_t::lightsamples() const

common/bspfile_q1.cc

@@ -188,14 +188,14 @@ bsp29_dface_t::bsp29_dface_t(const mface_t &model)
       firstedge(model.firstedge),
       numedges(numeric_cast<int16_t>(model.numedges, "dface_t::numedges")),
       texinfo(numeric_cast<int16_t>(model.texinfo, "dface_t::texinfo")),
-      styles(array_cast<decltype(styles)>(model.styles)),
+      styles(styles_mface_to_dface<decltype(styles)>(model.styles)),
       lightofs(model.lightofs)
 {
 }
 
 bsp29_dface_t::operator mface_t() const
 {
-    return {planenum, side, firstedge, numedges, texinfo, array_cast<decltype(mface_t::styles)>(styles), lightofs};
+    return {planenum, side, firstedge, numedges, texinfo, styles_dface_to_mface(styles), lightofs};
 }
 
 void bsp29_dface_t::stream_write(std::ostream &s) const
@@ -216,14 +216,14 @@ bsp2_dface_t::bsp2_dface_t(const mface_t &model)
       firstedge(model.firstedge),
       numedges(model.numedges),
       texinfo(model.texinfo),
-      styles(array_cast<decltype(styles)>(model.styles)),
+      styles(styles_mface_to_dface<decltype(styles)>(model.styles)),
       lightofs(model.lightofs)
 {
 }
 
 bsp2_dface_t::operator mface_t() const
 {
-    return {planenum, side, firstedge, numedges, texinfo, array_cast<decltype(mface_t::styles)>(styles), lightofs};
+    return {planenum, side, firstedge, numedges, texinfo, styles_dface_to_mface(styles), lightofs};
 }
 
 void bsp2_dface_t::stream_write(std::ostream &s) const

common/bspfile_q2.cc

@@ -17,6 +17,8 @@
     See file, 'COPYING', for details.
 */
 
+#include "common/log.hh"
+
 #include <common/bspfile.hh>
 #include <common/cmdlib.hh>
 #include <common/numeric_cast.hh>
@@ -96,15 +98,25 @@ q2_texinfo_t::q2_texinfo_t(const mtexinfo_t &model)
     : vecs(model.vecs),
       flags(model.flags.native_q2),
       value(model.value),
-      texture(array_cast<decltype(texture)>(model.texture)),
       nexttexinfo(model.nexttexinfo)
 {
+    if (!string_copy_to_array_z(model.texturename, texture)) {
+        logging::print("WARNING: texture name '{}' was truncated to fit in q2_texinfo_t ({} bytes)\n", model.texturename,
+            texture.size());
+    }
 }
 
 // convert to mbsp_t
 q2_texinfo_t::operator mtexinfo_t() const
 {
-    return {vecs, {.native_q2 = static_cast<q2_surf_flags_t>(flags)}, -1, value, array_cast<decltype(mtexinfo_t::texture)>(texture), nexttexinfo};
+    bool texturename_ok;
+    std::string texturename = string_copy_from_array_z(texture, &texturename_ok);
+
+    if (!texturename_ok) {
+        logging::print("WARNING: texture name {} was not zero-terminated", texturename);
+    }
+
+    return {vecs, {.native_q2 = static_cast<q2_surf_flags_t>(flags)}, -1, value, texturename, nexttexinfo};
 }
 
 void q2_texinfo_t::stream_write(std::ostream &s) const
@@ -125,14 +137,14 @@ q2_dface_t::q2_dface_t(const mface_t &model)
       firstedge(model.firstedge),
       numedges(numeric_cast<int16_t>(model.numedges, "dface_t::numedges")),
       texinfo(numeric_cast<int16_t>(model.texinfo, "dface_t::texinfo")),
-      styles(array_cast<decltype(styles)>(model.styles)),
+      styles(styles_mface_to_dface<decltype(styles)>(model.styles)),
       lightofs(model.lightofs)
 {
 }
 
 q2_dface_t::operator mface_t() const
 {
-    return {planenum, side, firstedge, numedges, texinfo, array_cast<decltype(mface_t::styles)>(styles), lightofs};
+    return {planenum, side, firstedge, numedges, texinfo, styles_dface_to_mface(styles), lightofs};
 }
 
 void q2_dface_t::stream_write(std::ostream &s) const
@@ -153,14 +165,14 @@ q2_dface_qbism_t::q2_dface_qbism_t(const mface_t &model)
       firstedge(model.firstedge),
       numedges(model.numedges),
       texinfo(model.texinfo),
-      styles(array_cast<decltype(styles)>(model.styles)),
+      styles(styles_mface_to_dface<decltype(styles)>(model.styles)),
       lightofs(model.lightofs)
 {
 }
 
 q2_dface_qbism_t::operator mface_t() const
 {
-    return {planenum, side, firstedge, numedges, texinfo, array_cast<decltype(mface_t::styles)>(styles), lightofs};
+    return {planenum, side, firstedge, numedges, texinfo, styles_dface_to_mface(styles), lightofs};
 }
 
 void q2_dface_qbism_t::stream_write(std::ostream &s) const
@@ -236,13 +248,13 @@ void q2_dleaf_qbism_t::stream_read(std::istream &s)
 
 // q2_dbrushside_t
 
-q2_dbrushside_t::q2_dbrushside_t(const q2_dbrushside_qbism_t &model)
+q2_dbrushside_t::q2_dbrushside_t(const mbrushside_t &model)
     : planenum(numeric_cast<uint16_t>(model.planenum, "dbrushside_t::planenum")),
       texinfo(numeric_cast<int16_t>(model.texinfo, "dbrushside_t::texinfo"))
 {
 }
 
-q2_dbrushside_t::operator q2_dbrushside_qbism_t() const
+q2_dbrushside_t::operator mbrushside_t() const
 {
     return {planenum, texinfo};
 }
@@ -256,3 +268,26 @@ void q2_dbrushside_t::stream_read(std::istream &s)
 {
     s >= std::tie(planenum, texinfo);
 }
+
+// q2_dbrushside_qbism_t
+
+q2_dbrushside_qbism_t::q2_dbrushside_qbism_t(const mbrushside_t &model)
+    : planenum(model.planenum),
+      texinfo(model.texinfo)
+{
+}
+
+q2_dbrushside_qbism_t::operator mbrushside_t() const
+{
+    return {planenum, texinfo};
+}
+
+void q2_dbrushside_qbism_t::stream_write(std::ostream &s) const
+{
+    s <= std::tie(planenum, texinfo);
+}
+
+void q2_dbrushside_qbism_t::stream_read(std::istream &s)
+{
+    s >= std::tie(planenum, texinfo);
+}

common/bspfile_sin.cc

@@ -17,6 +17,8 @@
     See file, 'COPYING', for details.
 */
 
+#include "common/log.hh"
+
 #include <common/bspfile.hh>
 #include <common/cmdlib.hh>
 #include <common/numeric_cast.hh>
@@ -51,7 +53,6 @@ void sin_lightinfo_t::stream_read(std::istream &s)
 sin_texinfo_t::sin_texinfo_t(const mtexinfo_t &model)
     : vecs(model.vecs),
       flags(model.flags.native_q2),
-      texture(model.texture),
       nexttexinfo(model.nexttexinfo),
       trans_mag(model.trans_mag),
       trans_angle(model.trans_angle),
@@ -64,12 +65,22 @@ sin_texinfo_t::sin_texinfo_t(const mtexinfo_t &model)
       color(model.color),
       groupname(model.groupname)
 {
+    if (!string_copy_to_array_z(model.texturename, texture)) {
+        logging::print("WARNING: texture name '{}' was truncated to fit in sin_texinfo_t ({} bytes)\n",
+            model.texturename, texture.size());
+    }
 }
 
 sin_texinfo_t::operator mtexinfo_t() const
 {
-    return {vecs, {.native_q2 = static_cast<q2_surf_flags_t>(flags)}, 0, 0, texture, nexttexinfo, trans_mag, trans_angle, base_angle, animtime, nonlit, translucence,
-            friction, restitution, color, groupname};
+    bool texturename_ok;
+    std::string texturename = string_copy_from_array_z(texture, &texturename_ok);
+
+    if (!texturename_ok) {
+        logging::print("WARNING: texture name {} was not zero-terminated", texturename);
+    }
+    return {vecs, {.native_q2 = static_cast<q2_surf_flags_t>(flags)}, 0, 0, texturename, nexttexinfo, trans_mag,
+        trans_angle, base_angle, animtime, nonlit, translucence, friction, restitution, color, groupname};
 }
 
 void sin_texinfo_t::stream_write(std::ostream &s) const
@@ -113,13 +124,13 @@ void sin_dface_t::stream_read(std::istream &s)
 
 // sin_dbrushside_t
 
-sin_dbrushside_t::sin_dbrushside_t(const q2_dbrushside_qbism_t &model)
+sin_dbrushside_t::sin_dbrushside_t(const mbrushside_t &model)
     : q2_dbrushside_t(model),
       lightinfo(model.lightinfo)
 {
 }
 
-sin_dbrushside_t::operator q2_dbrushside_qbism_t() const
+sin_dbrushside_t::operator mbrushside_t() const
 {
     return {planenum, texinfo, lightinfo};
 }