Merge pull request #299 from Hoikas/key_helpers

Add convert helper for `plKey::getObj()`.

Author: zrax

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.12)
 project(libhsplasma)
 
-set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)

Tools/src/Prp2Obj.cpp

@@ -116,7 +116,7 @@ int main(int argc, char* argv[])
     try {
         std::vector<plKey> MObjs = rm.getKeys(page->getLocation(), kGMaterial);
         for (size_t i = 0; i < MObjs.size(); i++) {
-            hsGMaterial* mat = hsGMaterial::Convert(rm.getObject(MObjs[i]));
+            hsGMaterial* mat = rm.getObject<hsGMaterial>(MObjs[i]);
             WriteMat(mat, &OS);
         }
     } catch (const hsException& e) {
@@ -138,7 +138,7 @@ int main(int argc, char* argv[])
         for (size_t i = 0; i < SObjs.size(); i++) {
             auto obj_f = std::find(objects.begin(), objects.end(), SObjs[i]->getName());
             if (obj_f != objects.end() || objects.size() == 0) {
-                plSceneObject* obj = plSceneObject::Convert(rm.getObject(SObjs[i]));
+                plSceneObject* obj = rm.getObject<plSceneObject>(SObjs[i]);
                 if (obj->getDrawInterface().Exists())
                     WriteObj(obj, &OS, objects.empty());
                 nObjects++;
@@ -163,17 +163,17 @@ static void WriteObj(plSceneObject* obj, hsStream* S, bool doXform)
         plDebug::Warning("Cannot get draw interface for {}", obj->getKey()->getName());
         return;
     }
-    plDrawInterface* draw = plDrawInterface::Convert(obj->getDrawInterface()->getObj());
+    plDrawInterface* draw = obj->getDrawInterface()->getObj<plDrawInterface>();
     plCoordinateInterface* coord = nullptr;
     if (obj->getCoordInterface().Exists())
-        coord = plCoordinateInterface::Convert(obj->getCoordInterface()->getObj());
+        coord = obj->getCoordInterface()->getObj<plCoordinateInterface>();
 
     S->writeStr(ST::format("\ng {}\n", obj->getKey()->getName()));
     for (size_t i=0; i<draw->getNumDrawables(); i++) {
         if (draw->getDrawableKey(i) == -1)
             continue;
 
-        plDrawableSpans* span = plDrawableSpans::Convert(draw->getDrawable(i)->getObj());
+        plDrawableSpans* span = draw->getDrawable(i)->getObj<plDrawableSpans>();
         plDISpanIndex di = span->getDIIndex(draw->getDrawableKey(i));
         if ((di.fFlags & plDISpanIndex::kMatrixOnly) != 0)
             continue;
@@ -187,11 +187,11 @@ static void WriteObj(plSceneObject* obj, hsStream* S, bool doXform)
             hsMatrix44 uvwXform;
             plKey matKey = span->getMaterials()[ice->getMaterialIdx()];
             if (matKey.Exists()) {
-                hsGMaterial* mat = hsGMaterial::Convert(matKey->getObj(), false);
+                hsGMaterial* mat = matKey->getObj<hsGMaterial>(false);
                 if (mat && mat->getLayers().size() > 0) {
-                    plLayerInterface* lay = plLayerInterface::Convert(mat->getLayers()[0]->getObj(), false);
+                    plLayerInterface* lay = mat->getLayers()[0]->getObj<plLayerInterface>(false);
                     while (lay && lay->getUnderLay().Exists())
-                        lay = plLayerInterface::Convert(lay->getUnderLay()->getObj(), false);
+                        lay = lay->getUnderLay()->getObj<plLayerInterface>(false);
                     uvwSrc = lay->getUVWSrc();
                     uvwXform = lay->getTransform();
                 }
@@ -263,9 +263,9 @@ static void WriteMat(hsGMaterial* mat, hsStream* S)
 
     // Obj doesn't support multiple textures, so we just get the texture
     // on the base of the first layer in each material...
-    plLayerInterface* lay = plLayerInterface::Convert(mat->getLayers()[0]->getObj(), false);
+    plLayerInterface* lay = mat->getLayers()[0]->getObj<plLayerInterface>(false);
     while (lay && lay->getUnderLay().Exists())
-        lay = plLayerInterface::Convert(lay->getUnderLay()->getObj(), false);
+        lay = lay->getUnderLay()->getObj<plLayerInterface>(false);
     if (lay == nullptr) {
         plDebug::Warning("Cannot get layer for {}", mat->getKey()->getName());
         return;

core/PRP/KeyedObject/plKey.h

@@ -21,6 +21,7 @@
 #include <cstddef>
 #include <functional>
 #include <list>
+#include <type_traits>
 
 #define GET_KEY_OBJECT(key, classname) \
     ((key.Exists() && key.isLoaded()) \
@@ -138,10 +139,32 @@ class HSPLASMA_EXPORT plKeyData
     const plUoid& getUoid() const { return fUoid; }
 
     /** Returns a pointer to the object referenced by this key */
-    class hsKeyedObject* getObj() { return fObjPtr; }
+    template<typename _KeyedObjT = class hsKeyedObject>
+    _KeyedObjT* getObj(bool requireValid = true)
+    {
+        static_assert(
+            std::is_base_of_v<class hsKeyedObject, _KeyedObjT>,
+            "Cannot convert to a type that does not derive from hsKeyedObject"
+        );
+        // If they just want the KeyedObject, avoid calling all the convert functions.
+        if constexpr (std::is_same_v<class hsKeyedObject, _KeyedObjT>)
+            return fObjPtr;
+        return _KeyedObjT::Convert(fObjPtr, requireValid);
+    }
 
     /** Returns a const pointer to the object referenced by this key */
-    const class hsKeyedObject* getObj() const { return fObjPtr; }
+    template<typename _KeyedObjT = class hsKeyedObject>
+    const _KeyedObjT* getObj(bool requireValid = true) const
+    {
+        static_assert(
+            std::is_base_of_v<class hsKeyedObject, _KeyedObjT>,
+            "Cannot convert to a type that does not derive from hsKeyedObject"
+        );
+        // If they just want the KeyedObject, avoid calling all the convert functions.
+        if constexpr (std::is_same_v<class hsKeyedObject, _KeyedObjT>)
+            return fObjPtr;
+        return _KeyedObjT::Convert(fObjPtr, requireValid);
+    }
 
     /** Sets the object referenced by this key. */
     void setObj(class hsKeyedObject* obj);

core/PRP/Object/plSceneObject.cpp

@@ -154,7 +154,7 @@ void plSceneObject::delModifier(size_t idx)
         if (key->getObj()->isStub()) {
             plDebug::Warning("WARNING:  Removing STUB modifier from SceneObject");
         } else {
-            plModifier* mod = plModifier::Convert(key->getObj());
+            plModifier* mod = key->getObj<plModifier>();
             mod->removeTarget(getKey());
         }
     }
@@ -169,7 +169,7 @@ void plSceneObject::clearModifiers()
                 plDebug::Warning("WARNING:  Removing STUB modifier from SceneObject");
                 continue;
             }
-            plModifier* mod = plModifier::Convert(key->getObj(), false);
+            plModifier* mod = key->getObj<plModifier>(false);
             mod->removeTarget(getKey());
         }
     }

core/PRP/Surface/plLayerInterface.cpp

@@ -57,7 +57,7 @@ plKey plLayerInterface::getBottomOfStack() const
             // What use is returning an unloaded bottom layer?
             break;
         }
-        const plLayerInterface* underLay = plLayerInterface::Convert(bottom->fUnderLay->getObj(), false);
+        const plLayerInterface* underLay = bottom->fUnderLay->getObj<plLayerInterface>(false);
         if (underLay == nullptr)
             break;
         bottom = underLay;

core/ResManager/plResManager.cpp

@@ -145,14 +145,6 @@ void plResManager::PrcWriteKey(pfPrcHelper* prc, hsKeyedObject* ko)
     PrcWriteKey(prc, ko->getKey());
 }
 
-hsKeyedObject* plResManager::getObject(const plKey& key)
-{
-    plKey fk = keys.findKey(key);
-    if (!fk.Exists())
-        return nullptr;
-    return fk->getObj();
-}
-
 plPageInfo* plResManager::ReadPage(const ST::string& filename, bool stub)
 {
     bool packed = true;
@@ -744,7 +736,7 @@ plSceneNode* plResManager::getSceneNode(const plLocation& loc)
     std::vector<plKey> kList = keys.getKeys(loc, kSceneNode);
     if (kList.empty())
         return nullptr;
-    return plSceneNode::Convert(kList[0]->getObj());
+    return kList[0]->getObj<plSceneNode>();
 }
 
 std::vector<plLocation> plResManager::getLocations()

core/ResManager/plResManager.h

@@ -177,7 +177,14 @@ class HSPLASMA_EXPORT plResManager
      * the key's internal object pointer.
      * \sa plKeyData::getObj()
      */
-    class hsKeyedObject* getObject(const plKey& key);
+    template<typename _KeyedObjectT = class hsKeyedObject>
+    _KeyedObjectT* getObject(const plKey& key, bool requireValid = true)
+    {
+        plKey fk = keys.findKey(key);
+        if (!fk.Exists())
+            return nullptr;
+        return fk->getObj<_KeyedObjectT>(requireValid);
+    }
 
     /** Returns the total number of keys registered for the specified plLocation */
     unsigned int countKeys(const plLocation& loc) { return keys.countKeys(loc); }