ResourceCache.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835
  1. //
  2. // Copyright (c) 2008-2014 the Urho3D project.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. #include "Precompiled.h"
  23. #include "Context.h"
  24. #include "CoreEvents.h"
  25. #include "FileSystem.h"
  26. #include "FileWatcher.h"
  27. #include "Image.h"
  28. #include "Log.h"
  29. #include "PackageFile.h"
  30. #include "ResourceCache.h"
  31. #include "ResourceEvents.h"
  32. #include "XMLFile.h"
  33. #include "DebugNew.h"
  34. namespace Urho3D
  35. {
  36. static const char* checkDirs[] = {
  37. "Fonts",
  38. "Materials",
  39. "Models",
  40. "Music",
  41. "Objects",
  42. "Particle",
  43. "PostProcess",
  44. "RenderPaths",
  45. "Scenes",
  46. "Scripts",
  47. "Sounds",
  48. "Shaders",
  49. "Techniques",
  50. "Textures",
  51. "UI",
  52. 0
  53. };
  54. static const SharedPtr<Resource> noResource;
  55. ResourceCache::ResourceCache(Context* context) :
  56. Object(context),
  57. autoReloadResources_(false),
  58. searchPackagesFirst_(true)
  59. {
  60. // Register Resource library object factories
  61. RegisterResourceLibrary(context_);
  62. }
  63. ResourceCache::~ResourceCache()
  64. {
  65. }
  66. bool ResourceCache::AddResourceDir(const String& pathName, unsigned int priority)
  67. {
  68. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  69. if (!fileSystem || !fileSystem->DirExists(pathName))
  70. {
  71. LOGERROR("Could not open directory " + pathName);
  72. return false;
  73. }
  74. // Convert path to absolute
  75. String fixedPath = SanitateResourceDirName(pathName);
  76. // Check that the same path does not already exist
  77. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  78. {
  79. if (!resourceDirs_[i].Compare(fixedPath, false))
  80. return true;
  81. }
  82. // If the priority isn't last or greater than size insert at position otherwise push.
  83. if (priority > PRIORITY_LAST && priority < resourceDirs_.Size())
  84. resourceDirs_.Insert(priority, fixedPath);
  85. else
  86. resourceDirs_.Push(fixedPath);
  87. // If resource auto-reloading active, create a file watcher for the directory
  88. if (autoReloadResources_)
  89. {
  90. SharedPtr<FileWatcher> watcher(new FileWatcher(context_));
  91. watcher->StartWatching(fixedPath, true);
  92. fileWatchers_.Push(watcher);
  93. }
  94. LOGINFO("Added resource path " + fixedPath);
  95. return true;
  96. }
  97. void ResourceCache::AddPackageFile(PackageFile* package, unsigned int priority)
  98. {
  99. // Do not add packages that failed to load
  100. if (!package || !package->GetNumFiles())
  101. return;
  102. // If the priority isn't last or greater than size insert at position otherwise push.
  103. if (priority > PRIORITY_LAST && priority < packages_.Size())
  104. packages_.Insert(priority, SharedPtr<PackageFile>(package));
  105. else
  106. packages_.Push(SharedPtr<PackageFile>(package));
  107. LOGINFO("Added resource package " + package->GetName());
  108. }
  109. bool ResourceCache::AddManualResource(Resource* resource)
  110. {
  111. if (!resource)
  112. {
  113. LOGERROR("Null manual resource");
  114. return false;
  115. }
  116. const String& name = resource->GetName();
  117. if (name.Empty())
  118. {
  119. LOGERROR("Manual resource with empty name, can not add");
  120. return false;
  121. }
  122. resource->ResetUseTimer();
  123. resourceGroups_[resource->GetType()].resources_[resource->GetNameHash()] = resource;
  124. UpdateResourceGroup(resource->GetType());
  125. return true;
  126. }
  127. void ResourceCache::RemoveResourceDir(const String& pathName)
  128. {
  129. String fixedPath = SanitateResourceDirName(pathName);
  130. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  131. {
  132. if (!resourceDirs_[i].Compare(fixedPath, false))
  133. {
  134. resourceDirs_.Erase(i);
  135. // Remove the filewatcher with the matching path
  136. for (unsigned j = 0; j < fileWatchers_.Size(); ++j)
  137. {
  138. if (!fileWatchers_[j]->GetPath().Compare(fixedPath, false))
  139. {
  140. fileWatchers_.Erase(j);
  141. break;
  142. }
  143. }
  144. LOGINFO("Removed resource path " + fixedPath);
  145. return;
  146. }
  147. }
  148. }
  149. void ResourceCache::RemovePackageFile(PackageFile* package, bool releaseResources, bool forceRelease)
  150. {
  151. for (Vector<SharedPtr<PackageFile> >::Iterator i = packages_.Begin(); i != packages_.End(); ++i)
  152. {
  153. if (*i == package)
  154. {
  155. if (releaseResources)
  156. ReleasePackageResources(*i, forceRelease);
  157. LOGINFO("Removed resource package " + (*i)->GetName());
  158. packages_.Erase(i);
  159. return;
  160. }
  161. }
  162. }
  163. void ResourceCache::RemovePackageFile(const String& fileName, bool releaseResources, bool forceRelease)
  164. {
  165. // Compare the name and extension only, not the path
  166. String fileNameNoPath = GetFileNameAndExtension(fileName);
  167. for (Vector<SharedPtr<PackageFile> >::Iterator i = packages_.Begin(); i != packages_.End(); ++i)
  168. {
  169. if (!GetFileNameAndExtension((*i)->GetName()).Compare(fileNameNoPath, false))
  170. {
  171. if (releaseResources)
  172. ReleasePackageResources(*i, forceRelease);
  173. LOGINFO("Removed resource package " + (*i)->GetName());
  174. packages_.Erase(i);
  175. return;
  176. }
  177. }
  178. }
  179. void ResourceCache::ReleaseResource(ShortStringHash type, const String& name, bool force)
  180. {
  181. StringHash nameHash(name);
  182. const SharedPtr<Resource>& existingRes = FindResource(type, nameHash);
  183. if (!existingRes)
  184. return;
  185. // If other references exist, do not release, unless forced
  186. if ((existingRes.Refs() == 1 && existingRes.WeakRefs() == 0) || force)
  187. {
  188. resourceGroups_[type].resources_.Erase(nameHash);
  189. UpdateResourceGroup(type);
  190. }
  191. }
  192. void ResourceCache::ReleaseResources(ShortStringHash type, bool force)
  193. {
  194. bool released = false;
  195. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  196. if (i != resourceGroups_.End())
  197. {
  198. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  199. j != i->second_.resources_.End();)
  200. {
  201. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  202. // If other references exist, do not release, unless forced
  203. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  204. {
  205. i->second_.resources_.Erase(current);
  206. released = true;
  207. }
  208. }
  209. }
  210. if (released)
  211. UpdateResourceGroup(type);
  212. }
  213. void ResourceCache::ReleaseResources(ShortStringHash type, const String& partialName, bool force)
  214. {
  215. bool released = false;
  216. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  217. if (i != resourceGroups_.End())
  218. {
  219. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  220. j != i->second_.resources_.End();)
  221. {
  222. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  223. if (current->second_->GetName().Contains(partialName))
  224. {
  225. // If other references exist, do not release, unless forced
  226. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  227. {
  228. i->second_.resources_.Erase(current);
  229. released = true;
  230. }
  231. }
  232. }
  233. }
  234. if (released)
  235. UpdateResourceGroup(type);
  236. }
  237. void ResourceCache::ReleaseResources(const String& partialName, bool force)
  238. {
  239. // Some resources refer to others, like materials to textures. Release twice to ensure these get released.
  240. // This is not necessary if forcing release
  241. unsigned repeat = force ? 1 : 2;
  242. while (repeat--)
  243. {
  244. for (HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Begin(); i != resourceGroups_.End(); ++i)
  245. {
  246. bool released = false;
  247. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  248. j != i->second_.resources_.End();)
  249. {
  250. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  251. if (current->second_->GetName().Contains(partialName))
  252. {
  253. // If other references exist, do not release, unless forced
  254. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  255. {
  256. i->second_.resources_.Erase(current);
  257. released = true;
  258. }
  259. }
  260. }
  261. if (released)
  262. UpdateResourceGroup(i->first_);
  263. }
  264. }
  265. }
  266. void ResourceCache::ReleaseAllResources(bool force)
  267. {
  268. unsigned repeat = force ? 1 : 2;
  269. while (repeat--)
  270. {
  271. for (HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Begin();
  272. i != resourceGroups_.End(); ++i)
  273. {
  274. bool released = false;
  275. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  276. j != i->second_.resources_.End();)
  277. {
  278. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  279. // If other references exist, do not release, unless forced
  280. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  281. {
  282. i->second_.resources_.Erase(current);
  283. released = true;
  284. }
  285. }
  286. if (released)
  287. UpdateResourceGroup(i->first_);
  288. }
  289. }
  290. }
  291. bool ResourceCache::ReloadResource(Resource* resource)
  292. {
  293. if (!resource)
  294. return false;
  295. resource->SendEvent(E_RELOADSTARTED);
  296. bool success = false;
  297. SharedPtr<File> file = GetFile(resource->GetName());
  298. if (file)
  299. success = resource->Load(*(file.Get()));
  300. if (success)
  301. {
  302. resource->ResetUseTimer();
  303. UpdateResourceGroup(resource->GetType());
  304. resource->SendEvent(E_RELOADFINISHED);
  305. return true;
  306. }
  307. // If reloading failed, do not remove the resource from cache, to allow for a new live edit to
  308. // attempt loading again
  309. resource->SendEvent(E_RELOADFAILED);
  310. return false;
  311. }
  312. void ResourceCache::SetMemoryBudget(ShortStringHash type, unsigned budget)
  313. {
  314. resourceGroups_[type].memoryBudget_ = budget;
  315. }
  316. void ResourceCache::SetAutoReloadResources(bool enable)
  317. {
  318. if (enable != autoReloadResources_)
  319. {
  320. if (enable)
  321. {
  322. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  323. {
  324. SharedPtr<FileWatcher> watcher(new FileWatcher(context_));
  325. watcher->StartWatching(resourceDirs_[i], true);
  326. fileWatchers_.Push(watcher);
  327. }
  328. SubscribeToEvent(E_BEGINFRAME, HANDLER(ResourceCache, HandleBeginFrame));
  329. }
  330. else
  331. {
  332. UnsubscribeFromEvent(E_BEGINFRAME);
  333. fileWatchers_.Clear();
  334. }
  335. autoReloadResources_ = enable;
  336. }
  337. }
  338. SharedPtr<File> ResourceCache::GetFile(const String& nameIn, bool SendEventOnFailure)
  339. {
  340. String name = SanitateResourceName(nameIn);
  341. File* file = 0;
  342. if (searchPackagesFirst_)
  343. {
  344. file = SearchPackages(name);
  345. if (!file)
  346. file = SearchResourceDirs(name);
  347. }
  348. else
  349. {
  350. file = SearchResourceDirs(name);
  351. if (!file)
  352. file = SearchPackages(name);
  353. }
  354. if (file)
  355. return SharedPtr<File>(file);
  356. if (SendEventOnFailure)
  357. {
  358. LOGERROR("Could not find resource " + name);
  359. using namespace ResourceNotFound;
  360. VariantMap& eventData = GetEventDataMap();
  361. eventData[P_RESOURCENAME] = name;
  362. SendEvent(E_RESOURCENOTFOUND, eventData);
  363. }
  364. return SharedPtr<File>();
  365. }
  366. Resource* ResourceCache::GetResource(ShortStringHash type, const String& name, bool SendEventOnFailure)
  367. {
  368. return GetResource(type, name.CString(), SendEventOnFailure);
  369. }
  370. Resource* ResourceCache::GetResource(ShortStringHash type, const char* nameIn, bool SendEventOnFailure)
  371. {
  372. String name = SanitateResourceName(nameIn);
  373. // If empty name, return null pointer immediately
  374. if (name.Empty())
  375. return 0;
  376. StringHash nameHash(name);
  377. const SharedPtr<Resource>& existing = FindResource(type, nameHash);
  378. if (existing)
  379. return existing;
  380. SharedPtr<Resource> resource;
  381. // Make sure the pointer is non-null and is a Resource subclass
  382. resource = DynamicCast<Resource>(context_->CreateObject(type));
  383. if (!resource)
  384. {
  385. LOGERROR("Could not load unknown resource type " + String(type));
  386. using namespace UnknownResourceType;
  387. VariantMap& eventData = GetEventDataMap();
  388. eventData[P_RESOURCETYPE] = type;
  389. SendEvent(E_UNKNOWNRESOURCETYPE, eventData);
  390. return 0;
  391. }
  392. // Attempt to load the resource
  393. SharedPtr<File> file = GetFile(name, SendEventOnFailure);
  394. if (!file)
  395. return 0;
  396. LOGDEBUG("Loading resource " + name);
  397. resource->SetName(file->GetName());
  398. if (!resource->Load(*(file.Get())))
  399. return 0;
  400. // Store to cache
  401. resource->ResetUseTimer();
  402. resourceGroups_[type].resources_[nameHash] = resource;
  403. UpdateResourceGroup(type);
  404. return resource;
  405. }
  406. void ResourceCache::GetResources(PODVector<Resource*>& result, ShortStringHash type) const
  407. {
  408. result.Clear();
  409. HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Find(type);
  410. if (i != resourceGroups_.End())
  411. {
  412. for (HashMap<StringHash, SharedPtr<Resource> >::ConstIterator j = i->second_.resources_.Begin();
  413. j != i->second_.resources_.End(); ++j)
  414. result.Push(j->second_);
  415. }
  416. }
  417. bool ResourceCache::Exists(const String& nameIn) const
  418. {
  419. String name = SanitateResourceName(nameIn);
  420. for (unsigned i = 0; i < packages_.Size(); ++i)
  421. {
  422. if (packages_[i]->Exists(name))
  423. return true;
  424. }
  425. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  426. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  427. {
  428. if (fileSystem->FileExists(resourceDirs_[i] + name))
  429. return true;
  430. }
  431. // Fallback using absolute path
  432. if (fileSystem->FileExists(name))
  433. return true;
  434. return false;
  435. }
  436. unsigned ResourceCache::GetMemoryBudget(ShortStringHash type) const
  437. {
  438. HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Find(type);
  439. if (i != resourceGroups_.End())
  440. return i->second_.memoryBudget_;
  441. else
  442. return 0;
  443. }
  444. unsigned ResourceCache::GetMemoryUse(ShortStringHash type) const
  445. {
  446. HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Find(type);
  447. if (i != resourceGroups_.End())
  448. return i->second_.memoryUse_;
  449. else
  450. return 0;
  451. }
  452. unsigned ResourceCache::GetTotalMemoryUse() const
  453. {
  454. unsigned total = 0;
  455. for (HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Begin(); i != resourceGroups_.End(); ++i)
  456. total += i->second_.memoryUse_;
  457. return total;
  458. }
  459. String ResourceCache::GetResourceFileName(const String& name) const
  460. {
  461. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  462. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  463. {
  464. if (fileSystem->FileExists(resourceDirs_[i] + name))
  465. return resourceDirs_[i] + name;
  466. }
  467. return String();
  468. }
  469. String ResourceCache::GetPreferredResourceDir(const String& path) const
  470. {
  471. String fixedPath = AddTrailingSlash(path);
  472. bool pathHasKnownDirs = false;
  473. bool parentHasKnownDirs = false;
  474. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  475. for (unsigned i = 0; checkDirs[i] != 0; ++i)
  476. {
  477. if (fileSystem->DirExists(fixedPath + checkDirs[i]))
  478. {
  479. pathHasKnownDirs = true;
  480. break;
  481. }
  482. }
  483. if (!pathHasKnownDirs)
  484. {
  485. String parentPath = GetParentPath(fixedPath);
  486. for (unsigned i = 0; checkDirs[i] != 0; ++i)
  487. {
  488. if (fileSystem->DirExists(parentPath + checkDirs[i]))
  489. {
  490. parentHasKnownDirs = true;
  491. break;
  492. }
  493. }
  494. // If path does not have known subdirectories, but the parent path has, use the parent instead
  495. if (parentHasKnownDirs)
  496. fixedPath = parentPath;
  497. }
  498. return fixedPath;
  499. }
  500. String ResourceCache::SanitateResourceName(const String& nameIn) const
  501. {
  502. // Sanitate unsupported constructs from the resource name
  503. String name = GetInternalPath(nameIn);
  504. name.Replace("../", "");
  505. name.Replace("./", "");
  506. // If the path refers to one of the resource directories, normalize the resource name
  507. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  508. if (resourceDirs_.Size())
  509. {
  510. String namePath = GetPath(name);
  511. String exePath = fileSystem->GetProgramDir();
  512. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  513. {
  514. String relativeResourcePath = resourceDirs_[i];
  515. if (relativeResourcePath.StartsWith(exePath))
  516. relativeResourcePath = relativeResourcePath.Substring(exePath.Length());
  517. if (namePath.StartsWith(resourceDirs_[i], false))
  518. namePath = namePath.Substring(resourceDirs_[i].Length());
  519. else if (namePath.StartsWith(relativeResourcePath, false))
  520. namePath = namePath.Substring(relativeResourcePath.Length());
  521. }
  522. name = namePath + GetFileNameAndExtension(name);
  523. }
  524. return name.Trimmed();
  525. }
  526. String ResourceCache::SanitateResourceDirName(const String& nameIn) const
  527. {
  528. String fixedPath = AddTrailingSlash(nameIn);
  529. if (!IsAbsolutePath(fixedPath))
  530. fixedPath = GetSubsystem<FileSystem>()->GetCurrentDir() + fixedPath;
  531. // Sanitate away /./ construct
  532. fixedPath.Replace("/./", "/");
  533. return fixedPath.Trimmed();
  534. }
  535. void ResourceCache::StoreResourceDependency(Resource* resource, const String& dependency)
  536. {
  537. // If resource reloading is not on, do not create the dependency data structure (saves memory)
  538. if (!resource || !autoReloadResources_)
  539. return;
  540. StringHash nameHash(resource->GetName());
  541. HashSet<StringHash>& dependents = dependentResources_[dependency];
  542. dependents.Insert(nameHash);
  543. }
  544. void ResourceCache::ResetDependencies(Resource* resource)
  545. {
  546. if (!resource || !autoReloadResources_)
  547. return;
  548. StringHash nameHash(resource->GetName());
  549. for (HashMap<StringHash, HashSet<StringHash> >::Iterator i = dependentResources_.Begin(); i !=
  550. dependentResources_.End();)
  551. {
  552. HashSet<StringHash>& dependents = i->second_;
  553. dependents.Erase(nameHash);
  554. if (dependents.Empty())
  555. i = dependentResources_.Erase(i);
  556. else
  557. ++i;
  558. }
  559. }
  560. const SharedPtr<Resource>& ResourceCache::FindResource(ShortStringHash type, StringHash nameHash)
  561. {
  562. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  563. if (i == resourceGroups_.End())
  564. return noResource;
  565. HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Find(nameHash);
  566. if (j == i->second_.resources_.End())
  567. return noResource;
  568. return j->second_;
  569. }
  570. const SharedPtr<Resource>& ResourceCache::FindResource(StringHash nameHash)
  571. {
  572. for (HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Begin(); i != resourceGroups_.End(); ++i)
  573. {
  574. HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Find(nameHash);
  575. if (j != i->second_.resources_.End())
  576. return j->second_;
  577. }
  578. return noResource;
  579. }
  580. void ResourceCache::ReleasePackageResources(PackageFile* package, bool force)
  581. {
  582. HashSet<ShortStringHash> affectedGroups;
  583. const HashMap<String, PackageEntry>& entries = package->GetEntries();
  584. for (HashMap<String, PackageEntry>::ConstIterator i = entries.Begin(); i != entries.End(); ++i)
  585. {
  586. StringHash nameHash(i->first_);
  587. // We do not know the actual resource type, so search all type containers
  588. for (HashMap<ShortStringHash, ResourceGroup>::Iterator j = resourceGroups_.Begin();
  589. j != resourceGroups_.End(); ++j)
  590. {
  591. HashMap<StringHash, SharedPtr<Resource> >::Iterator k = j->second_.resources_.Find(nameHash);
  592. if (k != j->second_.resources_.End())
  593. {
  594. // If other references exist, do not release, unless forced
  595. if ((k->second_.Refs() == 1 && k->second_.WeakRefs() == 0) || force)
  596. {
  597. j->second_.resources_.Erase(k);
  598. affectedGroups.Insert(j->first_);
  599. }
  600. break;
  601. }
  602. }
  603. }
  604. for (HashSet<ShortStringHash>::Iterator i = affectedGroups.Begin(); i != affectedGroups.End(); ++i)
  605. UpdateResourceGroup(*i);
  606. }
  607. void ResourceCache::UpdateResourceGroup(ShortStringHash type)
  608. {
  609. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  610. if (i == resourceGroups_.End())
  611. return;
  612. for (;;)
  613. {
  614. unsigned totalSize = 0;
  615. unsigned oldestTimer = 0;
  616. HashMap<StringHash, SharedPtr<Resource> >::Iterator oldestResource = i->second_.resources_.End();
  617. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  618. j != i->second_.resources_.End(); ++j)
  619. {
  620. totalSize += j->second_->GetMemoryUse();
  621. unsigned useTimer = j->second_->GetUseTimer();
  622. if (useTimer > oldestTimer)
  623. {
  624. oldestTimer = useTimer;
  625. oldestResource = j;
  626. }
  627. }
  628. i->second_.memoryUse_ = totalSize;
  629. // If memory budget defined and is exceeded, remove the oldest resource and loop again
  630. // (resources in use always return a zero timer and can not be removed)
  631. if (i->second_.memoryBudget_ && i->second_.memoryUse_ > i->second_.memoryBudget_ &&
  632. oldestResource != i->second_.resources_.End())
  633. {
  634. LOGDEBUG("Resource group " + oldestResource->second_->GetTypeName() + " over memory budget, releasing resource " +
  635. oldestResource->second_->GetName());
  636. i->second_.resources_.Erase(oldestResource);
  637. }
  638. else
  639. break;
  640. }
  641. }
  642. void ResourceCache::HandleBeginFrame(StringHash eventType, VariantMap& eventData)
  643. {
  644. for (unsigned i = 0; i < fileWatchers_.Size(); ++i)
  645. {
  646. String fileName;
  647. while (fileWatchers_[i]->GetNextChange(fileName))
  648. {
  649. StringHash fileNameHash(fileName);
  650. // If the filename is a resource we keep track of, reload it
  651. const SharedPtr<Resource>& resource = FindResource(fileNameHash);
  652. if (resource)
  653. {
  654. LOGDEBUG("Reloading changed resource " + fileName);
  655. ReloadResource(resource);
  656. }
  657. // Always perform dependency resource check for resource loaded from XML file as it could be used in inheritance
  658. if (!resource || GetExtension(resource->GetName()) == ".xml")
  659. {
  660. // Check if this is a dependency resource, reload dependents
  661. HashMap<StringHash, HashSet<StringHash> >::ConstIterator j = dependentResources_.Find(fileNameHash);
  662. if (j != dependentResources_.End())
  663. {
  664. // Reloading a resource may modify the dependency tracking structure. Therefore collect the
  665. // resources we need to reload first
  666. Vector<SharedPtr<Resource> > dependents;
  667. dependents.Reserve(j->second_.Size());
  668. for (HashSet<StringHash>::ConstIterator k = j->second_.Begin(); k != j->second_.End(); ++k)
  669. {
  670. const SharedPtr<Resource>& dependent = FindResource(*k);
  671. if (dependent)
  672. dependents.Push(dependent);
  673. }
  674. for (unsigned k = 0; k < dependents.Size(); ++k)
  675. {
  676. LOGDEBUG("Reloading resource " + dependents[k]->GetName() + " depending on " + fileName);
  677. ReloadResource(dependents[k]);
  678. }
  679. }
  680. }
  681. }
  682. }
  683. }
  684. File* ResourceCache::SearchResourceDirs(const String& nameIn)
  685. {
  686. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  687. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  688. {
  689. if (fileSystem->FileExists(resourceDirs_[i] + nameIn))
  690. {
  691. // Construct the file first with full path, then rename it to not contain the resource path,
  692. // so that the file's name can be used in further GetFile() calls (for example over the network)
  693. File* file(new File(context_, resourceDirs_[i] + nameIn));
  694. file->SetName(nameIn);
  695. return file;
  696. }
  697. }
  698. // Fallback using absolute path
  699. if (fileSystem->FileExists(nameIn))
  700. return new File(context_, nameIn);
  701. return 0;
  702. }
  703. File* ResourceCache::SearchPackages(const String& nameIn)
  704. {
  705. for (unsigned i = 0; i < packages_.Size(); ++i)
  706. {
  707. if (packages_[i]->Exists(nameIn))
  708. return new File(context_, packages_[i], nameIn);
  709. }
  710. return 0;
  711. }
  712. void RegisterResourceLibrary(Context* context)
  713. {
  714. Image::RegisterObject(context);
  715. XMLFile::RegisterObject(context);
  716. }
  717. }