asset.hpp

Go to the documentation of this file.

/*
  ASSET.hpp  -  Superinterface: bookkeeping view of "things" present in the session

  Copyright (C)         Lumiera.org
    2008,               Hermann Vosseler <Ichthyostega@web.de>

  This program 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; either version 2 of
  the License, or (at your option) any later version.

  This program 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 this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef STEAM_INTERFACE_ASSET_H
#define STEAM_INTERFACE_ASSET_H


#include "lib/error.hpp"
#include "lib/nocopy.hpp"
#include "include/logging.h"
#include "steam/asset/category.hpp"
#include "lib/hash-value.h"
#include "lib/p.hpp"

#include <boost/type_traits/is_base_of.hpp>
#include <boost/operators.hpp>

#include <cstddef>
#include <string>
#include <vector>
#include <set>


using std::string;
using std::vector;
using std::set;


namespace steam {
namespace asset {
  
  namespace error = lumiera::error;
  
  using std::size_t;
  using std::shared_ptr;
  using std::static_pointer_cast;
  
  using lib::HashVal;
  
  
  
  template<class KIND>
  class ID
    {
      HashVal hash_;
    public:
      ID (HashVal id)        : hash_(id)         {}
      ID (const KIND& asset) : hash_(asset.getID()) {}
      operator HashVal() const { return hash_; }
      
      static ID INVALID;
    };
    
  class DB;
  class Asset;
  class AssetManager;
  typedef const ID<Asset>& IDA;
  typedef lib::P<Asset>       PAsset;
  typedef lib::P<const Asset> PcAsset;

  
  
  
  
  class Asset 
    : public boost::totally_ordered1< Asset
    , util::NonCopyable             >
    {
    public:

      struct Ident
        : boost::totally_ordered<Ident>
        {
          string name;
    
          asset::Category category;
    
          const string org;
    
          const uint version;

          
          Ident (const string& n, 
                 const Category& cat, 
                 const string& o = "lumi", 
                 const uint ver=1);
          
          
          int compare (Ident const& other)   const;

          bool operator== (Ident const& oi)  const { return compare (oi) ==0; }
          bool operator<  (Ident const& oi)  const { return compare (oi) < 0; }
    
          operator string ()  const;
          
          bool isValid()  const;
        };
      
         
      /* ===== Asset ID and Datafields ===== */
        
    public:    
      const Ident ident;     

      virtual const ID<Asset>& getID()   const { return id; }
      
      
      bool operator== (Asset const& oa)  const { return ident == oa.ident; }
      bool operator<  (Asset const& oa)  const { return ident <  oa.ident; }
          
      virtual operator string ()  const;
      
      
      
    protected:
      const ID<Asset> id;   

      set<string> groups;

      const string shortDesc;

      const string longDesc;
      
      vector<PAsset> parents;
      vector<PAsset> dependants;
      
      bool enabled;

      
      
    protected:
      Asset (const Ident& idi);
      virtual ~Asset()           = 0;    
      
      virtual void unlink ();
      
      virtual void unlink (IDA target);
      
      void defineDependency (PAsset parent);
      void defineDependency (Asset& parent); 
      
      friend class AssetManager;
      friend class DB;
      
    private:
      void unregister (PAsset& other);



    
    public:
      const vector<PAsset>& getParents ()  const { return parents; }
      
      const vector<PAsset>& getDependant ()  const { return dependants; }
      
      bool isActive ()  const;
      
      bool enable (bool on=true);
      
      
    };
    
    
    
    
  /* ====== ordering of Assets and Asset-Pointers ====== */
  
  inline int 
  Asset::Ident::compare (Asset::Ident const& oi)  const
  { 
    int res;
    if (0 != (res=category.compare (oi.category)))  return res;
    if (0 != (res=org.compare (oi.org)))            return res;
    return name.compare (oi.name);
  }
  
  
  template<class A>
  inline const PcAsset
  pAsset (shared_ptr<A> const& subPtr)
  {
    return static_pointer_cast<const Asset,A> (subPtr);
  }
  
  
  template <class X>
  struct is_pAsset : boost::false_type {};
  
  template <class A>
  struct is_pAsset<shared_ptr<A>>
    : boost::is_base_of<Asset, A>      {};
  
  
  template<class KIND>
  ID<KIND> ID<KIND>::INVALID = ID{0};
  
  
}} // namespace steam::asset



namespace proc_interface {
  
  using steam::asset::Asset;
  using steam::asset::Category;
  using steam::asset::ID;
  using steam::asset::IDA;
  using steam::asset::PAsset;
}

#endif