Changeset 7229 in orxonox.OLD for branches/resources/src/lib/util

Timestamp:

Mar 21, 2006, 3:13:34 PM (19 years ago)

Author:

bensch

Message:

resources: some minor implementations

Location:

branches/resources/src/lib/util

Files:

• loading/resource.cc (modified) (1 diff)
• loading/resource.h (modified) (1 diff)
• multi_type.cc (modified) (3 diffs)
• multi_type.h (modified) (1 diff)

branches/resources/src/lib/util/loading/resource.cc

@@ -18 +18 @@
 #include "resource.h"
 
-using namespace std;
 
+namespace Loading
+{
 
-/**
- * standard constructor
-*/
-Resource::Resource (const std::string& fileName)
-{
-   this->setClassID(CL_RESOURCE, "Resource");
+  /**
+   * standard constructor
+  */
+  Resource::Resource (const std::string& fileName, ResourcePriority prio)
+  {
+    this->setClassID(CL_RESOURCE, "Resource");
+    this->resource = NULL;
 
+  }
+
+  /**
+   * standard deconstructor
+   */
+  Resource::~Resource ()
+  {
+    // delete what has to be deleted here
+  }
+
+  Resource::SharedResource::SharedResource()
+  {
+    this->referenceCount = 1;
+    this->type = CL_NULL;
+    this->prio = RP_NO;
+  }
 }
-
-/**
- * standard deconstructor
- */
-Resource::~Resource ()
-{
-  // delete what has to be deleted here
-}

branches/resources/src/lib/util/loading/resource.h

@@ -10 +10 @@
 #include "multi_type.h"
 #include <string>
-
-// FORWARD DECLARATION
+#include <map>
+#include <vector>
 
 
+namespace Loading
+{
+  // FORWARD DECLARATION
 
-//! An enumerator for different (UN)LOAD-types.
-/**
- * RP_NO:        will be unloaded on request
- * RP_LEVEL:     will be unloaded at the end of a Level
- * RP_CAMPAIGN:  will be unloaded at the end of a Campaign
- * RP_GAME:      will be unloaded at the end of the whole Game (when closing orxonox)
- */
-typedef enum ResourcePriority
-{
-  RP_NO        =   0,
-  RP_LEVEL     =   1,
-  RP_CAMPAIGN  =   2,
-  RP_GAME      =   3
-};
+  //! An enumerator for different (UN)LOAD-types.
+  /**
+   * RP_NO:        will be unloaded on request
+   * RP_LEVEL:     will be unloaded at the end of a Level
+   * RP_CAMPAIGN:  will be unloaded at the end of a Campaign
+   * RP_GAME:      will be unloaded at the end of the whole Game (when closing orxonox)
+   */
+  typedef enum ResourcePriority
+  {
+    RP_NO        =   0,
+    RP_LEVEL     =   1,
+    RP_CAMPAIGN  =   2,
+    RP_GAME      =   3
+  };
 
 
+  //! A Resource is an Object, that can be loaded from Disk
+  /**
+   * A Resource can cahnge the internal type, meaning it is a
+   * SmartPointer, that keeps track of the InternalCount of the
+   * Resource (SharedResource).
+   */
+  class Resource : virtual public BaseObject
+  {
+  protected:
+    /**
+     * This is a Class for the internal handling of the Resource.
+     * Any Resource keeps exactly one of these Classes, so it can
+     * reference and move it around, and keep track of how many
+     * references of it are stored.
+     */
+    class SharedResource
+    {
+    public:
+      SharedResource();
+      std::string       fileName;
 
-//! A Resource is an Object, that can be loaded from Disk
-/**
- *
- */
-class Resource : virtual public BaseObject {
+      unsigned int      referenceCount;    //!< How many times this Resource has been loaded.
+      ClassID           type;              //!< ResourceType of this Resource.
+      ResourcePriority  prio;              //!< The Priority of this resource. (can only be increased, so noone else will delete this)
 
- public:
-   Resource(const std::string& fileName);
-  virtual ~Resource();
+      MultiType         param[3];          //!< The Parameters given to this Resource.
+    };
 
-  virtual bool load(std::string& fileName, const MultiType& param1, const MultiType& param2);
-  virtual bool reload();
-  virtual bool unload();
 
- private:
-   std::string       fileName;
+  public:
+    Resource(const std::string& fileName = "", ResourcePriority prio = RP_LEVEL);
+    virtual ~Resource();
 
-   unsigned int      referenceCount;    //!< How many times this Resource has been loaded.
-/// TODO REMOVE THIS:   ResourceType      type;              //!< ResourceType of this Resource.
-   ResourcePriority  prio;              //!< The Priority of this resource. (can only be increased, so noone else will delete this)
+    // looks if the resource was already loaded and (if not) loads it.
+    virtual bool load(std::string& fileName = "",
+                      ResourcePriority prio = RP_LEVEL,
+                      const MultiType& param0 = MT_NULL,
+                      const MultiType& param1 = MT_NULL,
+                      const MultiType& param2 = MT_NULL);
+    // reloads the resource.
+    virtual bool reload() { };
+    // unloads the sharedResource (from this Resource)
+    virtual bool unload();
 
-   MultiType         param[3];          //!< The Parameters given to this Resource.
-};
+    // checks if a resource was already loaded.
+    bool isLoaded(std::string& fileName,
+                  const MultiType& param0 = MT_NULL,
+                  const MultiType& param1 = MT_NULL,
+                  const MultiType& param2 = MT_NULL);
 
+    // raises the priority can only be raised
+    void raisePriority(ResourcePriority prio);
+    /** @returns the referenceCount of the shared resource behind this resource or 0 if no internal Resource is stored */
+  unsigned int referenceCount() const { return (this->resource)? this->resource->referenceCount : 0; };
+
+  protected:
+    const SharedResource* findResource(std::string& fileName,
+                                       const MultiType& param0 = MT_NULL,
+                                       const MultiType& param1 = MT_NULL,
+                                       const MultiType& param2 = MT_NULL);
+
+  protected:
+    SharedResource*     resource;          //!< The internal Resource, this Resource is keeping (at the moment).
+
+    static std::map<ClassID, std::vector<SharedResource> > storedResources;
+  };
+
+}
 #endif /* _RESOURCE_H */

branches/resources/src/lib/util/multi_type.cc

@@ -408 +408 @@
 #endif
   ("MultiType of Type '%s' :: Values: BOOL: '%d', INT: '%d', FLOAT: '%f', CHAR: '%c', STRING '%s'\n",
-   MultiType::MultiTypeToString(this->type),
+   MultiType::MultiTypeToString(this->type).c_str(),
    this->getBool(),
    this->getInt(),
@@ -453 +453 @@
  * @returns: the Type as a constant String (do not delete)
  */
-const char* MultiType::MultiTypeToString(MT_Type type)
+const std::string& MultiType::MultiTypeToString(MT_Type type)
 {
   switch ( type )
   {
     case MT_BOOL:
-      return "bool";
+      return MultiType::multiTypeNames[1];
     case MT_INT:
-      return "int";
+      return MultiType::multiTypeNames[2];
     case MT_FLOAT:
-      return "float";
+      return MultiType::multiTypeNames[3];
     case MT_CHAR:
-      return "char";
+      return MultiType::multiTypeNames[4];
     case MT_STRING:
-      return "string";
-  }
-  return "NONE";
+      return MultiType::multiTypeNames[5];
+  }
+  return MultiType::multiTypeNames[0];
 }
 
@@ -478 +478 @@
 MT_Type MultiType::StringToMultiType(const std::string& type)
 {
-  if (type == "bool")
+  if (type == MultiType::multiTypeNames[1])
     return MT_BOOL;
-  if (type == "int")
+  if (type == MultiType::multiTypeNames[2])
     return MT_INT;
-  if (type, "float")
+  if (type == MultiType::multiTypeNames[3])
     return MT_FLOAT;
-  if (type == "char")
+  if (type == MultiType::multiTypeNames[4])
     return MT_CHAR;
-  if (type == "string")
+  if (type == MultiType::multiTypeNames[5])
     return MT_STRING;
 
   return MT_NULL;
 }
+
+
+const std::string MultiType::multiTypeNames[] =
+{
+  "none",
+  "bool",
+  "int",
+  "float",
+  "char",
+  "string"
+};

branches/resources/src/lib/util/multi_type.h

@@ -92 +92 @@
     void debug() const;
 
-    static const char* MultiTypeToString(MT_Type type);
+    static const std::string& MultiTypeToString(MT_Type type);
     static MT_Type StringToMultiType(const std::string& type);
 
   private:
+    /**
+     * The stored internal Value of the MultiType is handled in this union
+     * plus the string down below
+     */
     union MultiTypeValue
     {
-      bool              Bool;
-      int               Int;
-      float             Float;
-      char              Char;
+      bool              Bool;            //!< If Type == MT_BOOL this is the MultiType's value
+      int               Int;             //!< If Type == MT_INT this is the MultiType's value
+      float             Float;           //!< If Type == MT_FLOAT this is the MultiType's value
+      char              Char;            //!< If Type == MT_CHAR this is the MultiType's value
 //      std::string*      String;
-    }                   value;
-    std::string         storedString;
-    MT_Type             type;
+    }                   value;           //!< The stored internal value.
+    std::string         storedString;    //!< The String if either MT_TYPE == MT_STRING or if temporary requested
+    MT_Type             type;            //!< The Type of the MultiString.
+
+    static const std::string multiTypeNames[]; //!< An array to convert from String to MT_TYPE and backwords.
 };