File: resource.h

package info (click to toggle)
clanlib 1.0~svn3827-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 24,312 kB
  • ctags: 16,513
  • sloc: cpp: 101,606; xml: 6,410; makefile: 1,747; ansic: 463; perl: 424; php: 247; sh: 53
file content (125 lines) | stat: -rw-r--r-- 3,140 bytes parent folder | download | duplicates (7)
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
/*
**  ClanLib SDK
**  Copyright (c) 1997-2005 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    (if your name is missing here, please add it)
*/

//! clanCore="Resources"
//! header=core.h

#ifndef header_resource
#define header_resource

#ifdef CL_API_DLL
#ifdef CL_CORE_EXPORT
#define CL_API_CORE __declspec(dllexport)
#else
#define CL_API_CORE __declspec(dllimport)
#endif
#else
#define CL_API_CORE
#endif

#if _MSC_VER > 1000
#pragma once
#endif

#include "../System/sharedptr.h"
#include "../../signals.h"
#include <string>

class CL_ResourceManager;
class CL_ResourceData;
class CL_Resource_Generic;

#include "../XML/dom_element.h"

//: Interface for accessing a resource in the resource manager.
//- !group=Core/Resources!
//- !header=core.h!
class CL_API_CORE CL_Resource
{
//! Construction:
public:
	//: Resource constructor.
	CL_Resource(
		CL_DomElement &element,
		CL_ResourceManager *manager);

	CL_Resource(const CL_Resource &copy);

	CL_Resource();

	//: Resource destructor.
	virtual ~CL_Resource();

//! Attributes:
public:
	//: Returns the type of the resource.
	std::string get_type() const;

	//: Returns the name of the resource.
	std::string get_name() const;

	//: Returns the resource DOM element.
	CL_DomElement &get_element();

	//: Returns the resource manager.
	CL_ResourceManager get_manager();

	//: Returns the data with the matching name.
	CL_ResourceData *get_data(const std::string &name);

	//: Returns the current reference count.
	int get_reference_count() const;

//! Operations:
public:
	//: Attach some data to the resource.
	void attach_data(const std::string &name, CL_ResourceData *data);

	//: Detach some data from the resource.
	void detach_data(CL_ResourceData *data);

	//: Unloads the resource from memory.
	void unload();

	//: Loads the resource, using the prefered source as specified by
	//: the resource manager.
	void load();

//! Implementation:
private:
	CL_Resource(const CL_SharedPtr<CL_Resource_Generic> &impl);

	//: Pointer to implementation
	CL_SharedPtr<CL_Resource_Generic> impl;

	friend class CL_ResourceData;
	friend class CL_ResourceManager_Generic;
};

#endif