ResourceCache.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823
  1. //
  2. // Copyright (c) 2008-2013 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. if (fileWatchers_.Size() > i)
  136. fileWatchers_.Erase(i);
  137. LOGINFO("Removed resource path " + fixedPath);
  138. return;
  139. }
  140. }
  141. }
  142. void ResourceCache::RemovePackageFile(PackageFile* package, bool releaseResources, bool forceRelease)
  143. {
  144. for (Vector<SharedPtr<PackageFile> >::Iterator i = packages_.Begin(); i != packages_.End(); ++i)
  145. {
  146. if (*i == package)
  147. {
  148. if (releaseResources)
  149. ReleasePackageResources(*i, forceRelease);
  150. LOGINFO("Removed resource package " + (*i)->GetName());
  151. packages_.Erase(i);
  152. return;
  153. }
  154. }
  155. }
  156. void ResourceCache::RemovePackageFile(const String& fileName, bool releaseResources, bool forceRelease)
  157. {
  158. // Compare the name and extension only, not the path
  159. String fileNameNoPath = GetFileNameAndExtension(fileName);
  160. for (Vector<SharedPtr<PackageFile> >::Iterator i = packages_.Begin(); i != packages_.End(); ++i)
  161. {
  162. if (!GetFileNameAndExtension((*i)->GetName()).Compare(fileNameNoPath, false))
  163. {
  164. if (releaseResources)
  165. ReleasePackageResources(*i, forceRelease);
  166. LOGINFO("Removed resource package " + (*i)->GetName());
  167. packages_.Erase(i);
  168. return;
  169. }
  170. }
  171. }
  172. void ResourceCache::ReleaseResource(ShortStringHash type, const String& name, bool force)
  173. {
  174. StringHash nameHash(name);
  175. const SharedPtr<Resource>& existingRes = FindResource(type, nameHash);
  176. if (!existingRes)
  177. return;
  178. // If other references exist, do not release, unless forced
  179. if ((existingRes.Refs() == 1 && existingRes.WeakRefs() == 0) || force)
  180. {
  181. resourceGroups_[type].resources_.Erase(nameHash);
  182. UpdateResourceGroup(type);
  183. }
  184. }
  185. void ResourceCache::ReleaseResources(ShortStringHash type, bool force)
  186. {
  187. bool released = false;
  188. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  189. if (i != resourceGroups_.End())
  190. {
  191. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  192. j != i->second_.resources_.End();)
  193. {
  194. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  195. // If other references exist, do not release, unless forced
  196. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  197. {
  198. i->second_.resources_.Erase(current);
  199. released = true;
  200. }
  201. }
  202. }
  203. if (released)
  204. UpdateResourceGroup(type);
  205. }
  206. void ResourceCache::ReleaseResources(ShortStringHash type, const String& partialName, bool force)
  207. {
  208. bool released = false;
  209. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  210. if (i != resourceGroups_.End())
  211. {
  212. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  213. j != i->second_.resources_.End();)
  214. {
  215. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  216. if (current->second_->GetName().Contains(partialName))
  217. {
  218. // If other references exist, do not release, unless forced
  219. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  220. {
  221. i->second_.resources_.Erase(current);
  222. released = true;
  223. }
  224. }
  225. }
  226. }
  227. if (released)
  228. UpdateResourceGroup(type);
  229. }
  230. void ResourceCache::ReleaseResources(const String& partialName, bool force)
  231. {
  232. // Some resources refer to others, like materials to textures. Release twice to ensure these get released.
  233. // This is not necessary if forcing release
  234. unsigned repeat = force ? 1 : 2;
  235. while (repeat--)
  236. {
  237. for (HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Begin(); i != resourceGroups_.End(); ++i)
  238. {
  239. bool released = false;
  240. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  241. j != i->second_.resources_.End();)
  242. {
  243. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  244. if (current->second_->GetName().Contains(partialName))
  245. {
  246. // If other references exist, do not release, unless forced
  247. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  248. {
  249. i->second_.resources_.Erase(current);
  250. released = true;
  251. }
  252. }
  253. }
  254. if (released)
  255. UpdateResourceGroup(i->first_);
  256. }
  257. }
  258. }
  259. void ResourceCache::ReleaseAllResources(bool force)
  260. {
  261. unsigned repeat = force ? 1 : 2;
  262. while (repeat--)
  263. {
  264. for (HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Begin();
  265. i != resourceGroups_.End(); ++i)
  266. {
  267. bool released = false;
  268. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  269. j != i->second_.resources_.End();)
  270. {
  271. HashMap<StringHash, SharedPtr<Resource> >::Iterator current = j++;
  272. // If other references exist, do not release, unless forced
  273. if ((current->second_.Refs() == 1 && current->second_.WeakRefs() == 0) || force)
  274. {
  275. i->second_.resources_.Erase(current);
  276. released = true;
  277. }
  278. }
  279. if (released)
  280. UpdateResourceGroup(i->first_);
  281. }
  282. }
  283. }
  284. bool ResourceCache::ReloadResource(Resource* resource)
  285. {
  286. if (!resource)
  287. return false;
  288. resource->SendEvent(E_RELOADSTARTED);
  289. bool success = false;
  290. SharedPtr<File> file = GetFile(resource->GetName());
  291. if (file)
  292. success = resource->Load(*(file.Get()));
  293. if (success)
  294. {
  295. resource->ResetUseTimer();
  296. UpdateResourceGroup(resource->GetType());
  297. resource->SendEvent(E_RELOADFINISHED);
  298. return true;
  299. }
  300. // If reloading failed, do not remove the resource from cache, to allow for a new live edit to
  301. // attempt loading again
  302. resource->SendEvent(E_RELOADFAILED);
  303. return false;
  304. }
  305. void ResourceCache::SetMemoryBudget(ShortStringHash type, unsigned budget)
  306. {
  307. resourceGroups_[type].memoryBudget_ = budget;
  308. }
  309. void ResourceCache::SetAutoReloadResources(bool enable)
  310. {
  311. if (enable != autoReloadResources_)
  312. {
  313. if (enable)
  314. {
  315. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  316. {
  317. SharedPtr<FileWatcher> watcher(new FileWatcher(context_));
  318. watcher->StartWatching(resourceDirs_[i], true);
  319. fileWatchers_.Push(watcher);
  320. }
  321. SubscribeToEvent(E_BEGINFRAME, HANDLER(ResourceCache, HandleBeginFrame));
  322. }
  323. else
  324. {
  325. UnsubscribeFromEvent(E_BEGINFRAME);
  326. fileWatchers_.Clear();
  327. }
  328. autoReloadResources_ = enable;
  329. }
  330. }
  331. SharedPtr<File> ResourceCache::GetFile(const String& nameIn)
  332. {
  333. String name = SanitateResourceName(nameIn);
  334. File* file = 0;
  335. if (searchPackagesFirst_)
  336. {
  337. file = SearchPackages(name);
  338. if (!file)
  339. file = SearchResourceDirs(name);
  340. }
  341. else
  342. {
  343. file = SearchResourceDirs(name);
  344. if (!file)
  345. file = SearchPackages(name);
  346. }
  347. if (file)
  348. return SharedPtr<File>(file);
  349. LOGERROR("Could not find resource " + name);
  350. return SharedPtr<File>();
  351. }
  352. Resource* ResourceCache::GetResource(ShortStringHash type, const char* name)
  353. {
  354. return GetResource(type, String(name));
  355. }
  356. Resource* ResourceCache::GetResource(ShortStringHash type, const String& nameIn)
  357. {
  358. String name = SanitateResourceName(nameIn);
  359. // If empty name, return null pointer immediately
  360. if (name.Empty())
  361. return 0;
  362. StringHash nameHash(name);
  363. const SharedPtr<Resource>& existing = FindResource(type, nameHash);
  364. if (existing)
  365. return existing;
  366. SharedPtr<Resource> resource;
  367. // Make sure the pointer is non-null and is a Resource subclass
  368. resource = DynamicCast<Resource>(context_->CreateObject(type));
  369. if (!resource)
  370. {
  371. LOGERROR("Could not load unknown resource type " + String(type));
  372. return 0;
  373. }
  374. // Attempt to load the resource
  375. SharedPtr<File> file = GetFile(name);
  376. if (!file)
  377. return 0;
  378. LOGDEBUG("Loading resource " + name);
  379. resource->SetName(file->GetName());
  380. if (!resource->Load(*(file.Get())))
  381. return 0;
  382. // Store to cache
  383. resource->ResetUseTimer();
  384. resourceGroups_[type].resources_[nameHash] = resource;
  385. UpdateResourceGroup(type);
  386. return resource;
  387. }
  388. void ResourceCache::GetResources(PODVector<Resource*>& result, ShortStringHash type) const
  389. {
  390. result.Clear();
  391. HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Find(type);
  392. if (i != resourceGroups_.End())
  393. {
  394. for (HashMap<StringHash, SharedPtr<Resource> >::ConstIterator j = i->second_.resources_.Begin();
  395. j != i->second_.resources_.End(); ++j)
  396. result.Push(j->second_);
  397. }
  398. }
  399. bool ResourceCache::Exists(const String& nameIn) const
  400. {
  401. String name = SanitateResourceName(nameIn);
  402. for (unsigned i = 0; i < packages_.Size(); ++i)
  403. {
  404. if (packages_[i]->Exists(name))
  405. return true;
  406. }
  407. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  408. if (fileSystem)
  409. {
  410. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  411. {
  412. if (fileSystem->FileExists(resourceDirs_[i] + name))
  413. return true;
  414. }
  415. // Fallback using absolute path
  416. if (fileSystem->FileExists(name))
  417. return true;
  418. }
  419. return false;
  420. }
  421. unsigned ResourceCache::GetMemoryBudget(ShortStringHash type) const
  422. {
  423. HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Find(type);
  424. if (i != resourceGroups_.End())
  425. return i->second_.memoryBudget_;
  426. else
  427. return 0;
  428. }
  429. unsigned ResourceCache::GetMemoryUse(ShortStringHash type) const
  430. {
  431. HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Find(type);
  432. if (i != resourceGroups_.End())
  433. return i->second_.memoryUse_;
  434. else
  435. return 0;
  436. }
  437. unsigned ResourceCache::GetTotalMemoryUse() const
  438. {
  439. unsigned total = 0;
  440. for (HashMap<ShortStringHash, ResourceGroup>::ConstIterator i = resourceGroups_.Begin(); i != resourceGroups_.End(); ++i)
  441. total += i->second_.memoryUse_;
  442. return total;
  443. }
  444. String ResourceCache::GetResourceFileName(const String& name) const
  445. {
  446. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  447. if (fileSystem)
  448. {
  449. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  450. {
  451. if (fileSystem->FileExists(resourceDirs_[i] + name))
  452. return resourceDirs_[i] + name;
  453. }
  454. }
  455. return String();
  456. }
  457. String ResourceCache::GetPreferredResourceDir(const String& path) const
  458. {
  459. String fixedPath = AddTrailingSlash(path);
  460. bool pathHasKnownDirs = false;
  461. bool parentHasKnownDirs = false;
  462. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  463. // If no filesystem, can not check directory existence, so just return the original path
  464. if (!fileSystem)
  465. return fixedPath;
  466. for (unsigned i = 0; checkDirs[i] != 0; ++i)
  467. {
  468. if (fileSystem->DirExists(fixedPath + checkDirs[i]))
  469. {
  470. pathHasKnownDirs = true;
  471. break;
  472. }
  473. }
  474. if (!pathHasKnownDirs)
  475. {
  476. String parentPath = GetParentPath(fixedPath);
  477. for (unsigned i = 0; checkDirs[i] != 0; ++i)
  478. {
  479. if (fileSystem->DirExists(parentPath + checkDirs[i]))
  480. {
  481. parentHasKnownDirs = true;
  482. break;
  483. }
  484. }
  485. // If path does not have known subdirectories, but the parent path has, use the parent instead
  486. if (parentHasKnownDirs)
  487. fixedPath = parentPath;
  488. }
  489. return fixedPath;
  490. }
  491. String ResourceCache::SanitateResourceName(const String& nameIn) const
  492. {
  493. // Sanitate unsupported constructs from the resource name
  494. String name = GetInternalPath(nameIn);
  495. name.Replace("../", "");
  496. name.Replace("./", "");
  497. // If the path refers to one of the resource directories, normalize the resource name
  498. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  499. if (fileSystem && resourceDirs_.Size())
  500. {
  501. String namePath = GetPath(name);
  502. String exePath = fileSystem->GetProgramDir();
  503. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  504. {
  505. String relativeResourcePath = resourceDirs_[i];
  506. if (relativeResourcePath.StartsWith(exePath))
  507. relativeResourcePath = relativeResourcePath.Substring(exePath.Length());
  508. if (namePath.StartsWith(resourceDirs_[i], false))
  509. namePath = namePath.Substring(resourceDirs_[i].Length());
  510. else if (namePath.StartsWith(relativeResourcePath, false))
  511. namePath = namePath.Substring(relativeResourcePath.Length());
  512. }
  513. name = namePath + GetFileNameAndExtension(name);
  514. }
  515. return name.Trimmed();
  516. }
  517. String ResourceCache::SanitateResourceDirName(const String& nameIn) const
  518. {
  519. String fixedPath = AddTrailingSlash(nameIn);
  520. if (!IsAbsolutePath(fixedPath))
  521. fixedPath = GetSubsystem<FileSystem>()->GetCurrentDir() + fixedPath;
  522. // Sanitate away /./ construct
  523. fixedPath.Replace("/./", "/");
  524. return fixedPath.Trimmed();
  525. }
  526. void ResourceCache::StoreResourceDependency(Resource* resource, const String& dependency)
  527. {
  528. // If resource reloading is not on, do not create the dependency data structure (saves memory)
  529. if (!resource || !autoReloadResources_)
  530. return;
  531. StringHash nameHash(resource->GetName());
  532. HashSet<StringHash>& dependents = dependentResources_[dependency];
  533. dependents.Insert(nameHash);
  534. }
  535. void ResourceCache::ResetDependencies(Resource* resource)
  536. {
  537. if (!resource || !autoReloadResources_)
  538. return;
  539. StringHash nameHash(resource->GetName());
  540. for (HashMap<StringHash, HashSet<StringHash> >::Iterator i = dependentResources_.Begin(); i !=
  541. dependentResources_.End();)
  542. {
  543. HashSet<StringHash>& dependents = i->second_;
  544. dependents.Erase(nameHash);
  545. if (dependents.Empty())
  546. i = dependentResources_.Erase(i);
  547. else
  548. ++i;
  549. }
  550. }
  551. const SharedPtr<Resource>& ResourceCache::FindResource(ShortStringHash type, StringHash nameHash)
  552. {
  553. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  554. if (i == resourceGroups_.End())
  555. return noResource;
  556. HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Find(nameHash);
  557. if (j == i->second_.resources_.End())
  558. return noResource;
  559. return j->second_;
  560. }
  561. const SharedPtr<Resource>& ResourceCache::FindResource(StringHash nameHash)
  562. {
  563. for (HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Begin(); i != resourceGroups_.End(); ++i)
  564. {
  565. HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Find(nameHash);
  566. if (j != i->second_.resources_.End())
  567. return j->second_;
  568. }
  569. return noResource;
  570. }
  571. void ResourceCache::ReleasePackageResources(PackageFile* package, bool force)
  572. {
  573. HashSet<ShortStringHash> affectedGroups;
  574. const HashMap<String, PackageEntry>& entries = package->GetEntries();
  575. for (HashMap<String, PackageEntry>::ConstIterator i = entries.Begin(); i != entries.End(); ++i)
  576. {
  577. StringHash nameHash(i->first_);
  578. // We do not know the actual resource type, so search all type containers
  579. for (HashMap<ShortStringHash, ResourceGroup>::Iterator j = resourceGroups_.Begin();
  580. j != resourceGroups_.End(); ++j)
  581. {
  582. HashMap<StringHash, SharedPtr<Resource> >::Iterator k = j->second_.resources_.Find(nameHash);
  583. if (k != j->second_.resources_.End())
  584. {
  585. // If other references exist, do not release, unless forced
  586. if ((k->second_.Refs() == 1 && k->second_.WeakRefs() == 0) || force)
  587. {
  588. j->second_.resources_.Erase(k);
  589. affectedGroups.Insert(j->first_);
  590. }
  591. break;
  592. }
  593. }
  594. }
  595. for (HashSet<ShortStringHash>::Iterator i = affectedGroups.Begin(); i != affectedGroups.End(); ++i)
  596. UpdateResourceGroup(*i);
  597. }
  598. void ResourceCache::UpdateResourceGroup(ShortStringHash type)
  599. {
  600. HashMap<ShortStringHash, ResourceGroup>::Iterator i = resourceGroups_.Find(type);
  601. if (i == resourceGroups_.End())
  602. return;
  603. for (;;)
  604. {
  605. unsigned totalSize = 0;
  606. unsigned oldestTimer = 0;
  607. HashMap<StringHash, SharedPtr<Resource> >::Iterator oldestResource = i->second_.resources_.End();
  608. for (HashMap<StringHash, SharedPtr<Resource> >::Iterator j = i->second_.resources_.Begin();
  609. j != i->second_.resources_.End(); ++j)
  610. {
  611. totalSize += j->second_->GetMemoryUse();
  612. unsigned useTimer = j->second_->GetUseTimer();
  613. if (useTimer > oldestTimer)
  614. {
  615. oldestTimer = useTimer;
  616. oldestResource = j;
  617. }
  618. }
  619. i->second_.memoryUse_ = totalSize;
  620. // If memory budget defined and is exceeded, remove the oldest resource and loop again
  621. // (resources in use always return a zero timer and can not be removed)
  622. if (i->second_.memoryBudget_ && i->second_.memoryUse_ > i->second_.memoryBudget_ &&
  623. oldestResource != i->second_.resources_.End())
  624. {
  625. LOGDEBUG("Resource group " + oldestResource->second_->GetTypeName() + " over memory budget, releasing resource " +
  626. oldestResource->second_->GetName());
  627. i->second_.resources_.Erase(oldestResource);
  628. }
  629. else
  630. break;
  631. }
  632. }
  633. void ResourceCache::HandleBeginFrame(StringHash eventType, VariantMap& eventData)
  634. {
  635. for (unsigned i = 0; i < fileWatchers_.Size(); ++i)
  636. {
  637. String fileName;
  638. while (fileWatchers_[i]->GetNextChange(fileName))
  639. {
  640. StringHash fileNameHash(fileName);
  641. // If the filename is a resource we keep track of, reload it
  642. const SharedPtr<Resource>& resource = FindResource(fileNameHash);
  643. if (resource)
  644. {
  645. LOGDEBUG("Reloading changed resource " + fileName);
  646. ReloadResource(resource);
  647. }
  648. else
  649. {
  650. // Check if this is a dependency resource, reload dependents
  651. HashMap<StringHash, HashSet<StringHash> >::ConstIterator j = dependentResources_.Find(fileNameHash);
  652. if (j != dependentResources_.End())
  653. {
  654. // Reloading a resource may modify the dependency tracking structure. Therefore collect the
  655. // resources we need to reload first
  656. Vector<SharedPtr<Resource> > dependents;
  657. for (HashSet<StringHash>::ConstIterator k = j->second_.Begin(); k != j->second_.End(); ++k)
  658. {
  659. const SharedPtr<Resource>& dependent = FindResource(*k);
  660. if (dependent)
  661. dependents.Push(dependent);
  662. }
  663. for (unsigned k = 0; k < dependents.Size(); ++k)
  664. {
  665. LOGDEBUG("Reloading resource " + dependents[k]->GetName() + " depending on " + fileName);
  666. ReloadResource(dependents[k]);
  667. }
  668. }
  669. }
  670. }
  671. }
  672. }
  673. File* ResourceCache::SearchResourceDirs(const String& nameIn)
  674. {
  675. // Then the filesystem
  676. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  677. if (fileSystem)
  678. {
  679. for (unsigned i = 0; i < resourceDirs_.Size(); ++i)
  680. {
  681. if (fileSystem->FileExists(resourceDirs_[i] + nameIn))
  682. {
  683. // Construct the file first with full path, then rename it to not contain the resource path,
  684. // so that the file's name can be used in further GetFile() calls (for example over the network)
  685. File* file(new File(context_, resourceDirs_[i] + nameIn));
  686. file->SetName(nameIn);
  687. return file;
  688. }
  689. }
  690. // Fallback using absolute path
  691. if (fileSystem->FileExists(nameIn))
  692. return new File(context_, nameIn);
  693. }
  694. return 0;
  695. }
  696. File* ResourceCache::SearchPackages(const String& nameIn)
  697. {
  698. // Check first the packages
  699. for (unsigned i = 0; i < packages_.Size(); ++i)
  700. {
  701. if (packages_[i]->Exists(nameIn))
  702. return new File(context_, packages_[i], nameIn);
  703. }
  704. return 0;
  705. }
  706. void RegisterResourceLibrary(Context* context)
  707. {
  708. Image::RegisterObject(context);
  709. XMLFile::RegisterObject(context);
  710. }
  711. }