/usr/include/cegui-0.8.7/CEGUI/ResourceProvider.h is in libcegui-mk2-dev 0.8.7-1.3+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | /***********************************************************************
created: 8/7/2004
author: James '_mental_' O'Sullivan
purpose: Defines abstract base class for loading DataContainer objects
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIResourceProvider_h_
#define _CEGUIResourceProvider_h_
#include "CEGUI/Base.h"
#include "CEGUI/DataContainer.h"
#include "CEGUI/String.h"
#include <vector>
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Abstract class that defines the required interface for all resource provider sub-classes.
A ResourceProvider is used to load both XML and binary data from an external source. This could be from a filesystem or the resource manager of a specific renderer.
*/
class CEGUIEXPORT ResourceProvider :
public AllocatedObject<ResourceProvider>
{
public:
/*************************************************************************
Construction and Destruction
*************************************************************************/
/*!
\brief
Constructor for the ResourceProvider class
*/
ResourceProvider() { }
/*!
\brief
Destructor for the ResourceProvider class
*/
virtual ~ResourceProvider(void) { }
/*************************************************************************
Accessor functions
*************************************************************************/
// /*!
// \brief
// Load XML data using InputSource objects.
//
// \param filename
// String containing a filename of the resource to be loaded.
//
// \param output
// Reference to a InputSourceContainer object to load the data into.
// */
// virtual void loadInputSourceContainer(const String& filename, InputSourceContainer& output) = 0;
/*!
\brief
Load raw binary data.
\param filename
String containing a filename of the resource to be loaded.
\param output
Reference to a RawDataContainer object to load the data into.
\param resourceGroup
Optional String that may be used by implementations to identify the group from
which the resource should be loaded.
*/
virtual void loadRawDataContainer(const String& filename, RawDataContainer& output, const String& resourceGroup) = 0;
/*!
\brief
Unload raw binary data. This gives the resource provider a change to unload the data
in its own way before the data container object is destroyed. If it does nothing,
then the object will release its memory.
\param data
Reference to a RawDataContainer object that is about to be destroyed.
*/
virtual void unloadRawDataContainer(RawDataContainer&) { }
/*!
\brief
Return the current default resource group identifier.
\return
String object containing the currently set default resource group identifier.
*/
const String& getDefaultResourceGroup(void) const { return d_defaultResourceGroup; }
/*!
\brief
Set the default resource group identifier.
\param resourceGroup
String object containing the default resource group identifier to be used.
\return
Nothing.
*/
void setDefaultResourceGroup(const String& resourceGroup) { d_defaultResourceGroup = resourceGroup; }
/** enumerate the files in \a resource_group that match \a file_pattern and
append thier names to \a out_vec
*/
virtual size_t getResourceGroupFileNames(std::vector<String>& out_vec,
const String& file_pattern,
const String& resource_group) = 0;
protected:
String d_defaultResourceGroup; //!< Default resource group identifier.
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUIResourceProvider_h_
|