ResourceCache.cpp 28 KB

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