Dogcows Code - chaz/yoink/blob - src/Moof/Resource.hh

   1
   2 /*******************************************************************************
   3
   4  Copyright (c) 2009, Charles McGarvey
   5  All rights reserved.
   6
   7  Redistribution   and   use  in  source  and  binary  forms,  with  or  without
   8  modification, are permitted provided that the following conditions are met:
   9
  10    * Redistributions  of  source  code  must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    * Redistributions  in binary form must reproduce the above copyright notice,
  13      this  list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15
  16  THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  20  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22  SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23  CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24  OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 *******************************************************************************/
  28
  29 #ifndef _MOOF_RESOURCE_HH_
  30 #define _MOOF_RESOURCE_HH_
  31
  32 /**
  33  * @file Resource.hh
  34  * Interface for textures, sounds, and other types of resources.
  35  */
  36
  37 #include <stdexcept>
  38 #include <string>
  39 #include <vector>
  40
  41
  42 namespace Mf {
  43
  44
  45 /**
  46  * Generic resource class.
  47  */
  48
  49 class Resource
  50 {
  51 public:
  52         struct Exception : public std::runtime_error
  53         {
  54                 explicit Exception(const std::string& what_arg) :
  55                         std::runtime_error(what_arg) {}
  56         };
  57
  58         virtual ~Resource();
  59
  60
  61         /**
  62          * Add a directory to search when looking for resource files.
  63          * @param directory Path to a directory.
  64          */
  65
  66         static void addSearchPath(const std::string& directory);
  67
  68         /**
  69          * Get the path to a resource of a given name.
  70          * @param name Name of a resource.  The name will be appended to each search
  71          * directory in order.
  72          * @return The first path found which resolves to a file.
  73          */
  74
  75         static std::string getPath(const std::string& name);
  76
  77 private:
  78         static std::vector<std::string> searchPaths_;
  79 };
  80
  81
  82 } // namespace Mf
  83
  84 #endif // _MOOF_RESOURCE_HH_
  85
  86 /** vim: set ts=4 sw=4 tw=80: *************************************************/
  87