ResourceFile.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_SYSTEM_RESOURCE_FILE_HPP
#define NOMLIB_SYSTEM_RESOURCE_FILE_HPP
 
#include <string>
#include <vector>
#include <memory>
 
#include "nomlib/config.hpp"
 
namespace nom {

class ResourceFile
{
  public:
    typedef ResourceFile self_type;
 
    static const ResourceFile null;
 
    enum Type
    {
      Invalid = 0,
      Graphic,
      Movie,
      Audio,
      TrueTypeFont,
      BitmapFont
    };

    ResourceFile( void );

    virtual ~ResourceFile( void );

    ResourceFile( const std::string& name );

    ResourceFile( const std::string& name, const std::string& file_path );

    ResourceFile( const std::string& name, const std::string& file_path, ResourceFile::Type type );

    bool operator <( const self_type& rhs ) const;

    bool operator ==( const self_type& rhs ) const;

    bool exists( void ) const;

    const std::string& name( void ) const;

    const std::string& path( void ) const;

    ResourceFile::Type type( void ) const;
 
    bool loaded( void ) const;

    void set_name( const std::string& name );

    void set_path( const std::string& file_path );

    void set_type( ResourceFile::Type type );
 
    void set_loaded( bool state );
 
  private:
    std::string name_;

    std::string path_;

    ResourceFile::Type type_;
 
  public:
    mutable bool loaded_;
};
 
} // namespace nom
 
#endif // include guard defined