CCScheduler.cpp 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088
  1. /****************************************************************************
  2. Copyright (c) 2008-2010 Ricardo Quesada
  3. Copyright (c) 2010-2012 cocos2d-x.org
  4. Copyright (c) 2011 Zynga Inc.
  5. Copyright (c) 2013-2017 Chukong Technologies Inc.
  6. http://www.cocos2d-x.org
  7. Permission is hereby granted, free of charge, to any person obtaining a copy
  8. of this software and associated documentation files (the "Software"), to deal
  9. in the Software without restriction, including without limitation the rights
  10. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. copies of the Software, and to permit persons to whom the Software is
  12. furnished to do so, subject to the following conditions:
  13. The above copyright notice and this permission notice shall be included in
  14. all copies or substantial portions of the Software.
  15. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21. THE SOFTWARE.
  22. ****************************************************************************/
  23. #include "base/CCScheduler.h"
  24. #include "base/ccMacros.h"
  25. #include "base/CCDirector.h"
  26. #include "base/utlist.h"
  27. #include "base/ccCArray.h"
  28. #include "base/CCScriptSupport.h"
  29. NS_CC_BEGIN
  30. // data structures
  31. // A list double-linked list used for "updates with priority"
  32. typedef struct _listEntry
  33. {
  34. struct _listEntry *prev, *next;
  35. ccSchedulerFunc callback;
  36. void *target;
  37. int priority;
  38. bool paused;
  39. bool markedForDeletion; // selector will no longer be called and entry will be removed at end of the next tick
  40. } tListEntry;
  41. typedef struct _hashUpdateEntry
  42. {
  43. tListEntry **list; // Which list does it belong to ?
  44. tListEntry *entry; // entry in the list
  45. void *target;
  46. ccSchedulerFunc callback;
  47. UT_hash_handle hh;
  48. } tHashUpdateEntry;
  49. // Hash Element used for "selectors with interval"
  50. typedef struct _hashSelectorEntry
  51. {
  52. ccArray *timers;
  53. void *target;
  54. int timerIndex;
  55. Timer *currentTimer;
  56. bool paused;
  57. UT_hash_handle hh;
  58. } tHashTimerEntry;
  59. // implementation Timer
  60. Timer::Timer()
  61. : _scheduler(nullptr)
  62. , _elapsed(-1)
  63. , _runForever(false)
  64. , _useDelay(false)
  65. , _timesExecuted(0)
  66. , _repeat(0)
  67. , _delay(0.0f)
  68. , _interval(0.0f)
  69. , _aborted(false)
  70. {
  71. }
  72. void Timer::setupTimerWithInterval(float seconds, unsigned int repeat, float delay)
  73. {
  74. _elapsed = -1;
  75. _interval = seconds;
  76. _delay = delay;
  77. _useDelay = (_delay > 0.0f) ? true : false;
  78. _repeat = repeat;
  79. _runForever = (_repeat == CC_REPEAT_FOREVER) ? true : false;
  80. _timesExecuted = 0;
  81. }
  82. void Timer::update(float dt)
  83. {
  84. if (_elapsed == -1)
  85. {
  86. _elapsed = 0;
  87. _timesExecuted = 0;
  88. return;
  89. }
  90. // accumulate elapsed time
  91. _elapsed += dt;
  92. // deal with delay
  93. if (_useDelay)
  94. {
  95. if (_elapsed < _delay)
  96. {
  97. return;
  98. }
  99. _timesExecuted += 1; // important to increment before call trigger
  100. trigger(_delay);
  101. _elapsed = _elapsed - _delay;
  102. _useDelay = false;
  103. // after delay, the rest time should compare with interval
  104. if (isExhausted())
  105. { //unschedule timer
  106. cancel();
  107. return;
  108. }
  109. }
  110. // if _interval == 0, should trigger once every frame
  111. float interval = (_interval > 0) ? _interval : _elapsed;
  112. while ((_elapsed >= interval) && !_aborted)
  113. {
  114. _timesExecuted += 1; // important to increment before call trigger
  115. trigger(interval);
  116. _elapsed -= interval;
  117. if (isExhausted())
  118. {
  119. cancel();
  120. break;
  121. }
  122. if (_elapsed <= 0.f)
  123. {
  124. break;
  125. }
  126. }
  127. }
  128. bool Timer::isExhausted() const
  129. {
  130. return !_runForever && _timesExecuted > _repeat;
  131. }
  132. // TimerTargetSelector
  133. TimerTargetSelector::TimerTargetSelector()
  134. : _target(nullptr)
  135. , _selector(nullptr)
  136. {
  137. }
  138. bool TimerTargetSelector::initWithSelector(Scheduler* scheduler, SEL_SCHEDULE selector, Ref* target, float seconds, unsigned int repeat, float delay)
  139. {
  140. _scheduler = scheduler;
  141. _target = target;
  142. _selector = selector;
  143. setupTimerWithInterval(seconds, repeat, delay);
  144. return true;
  145. }
  146. void TimerTargetSelector::trigger(float dt)
  147. {
  148. if (_target && _selector)
  149. {
  150. (_target->*_selector)(dt);
  151. }
  152. }
  153. void TimerTargetSelector::cancel()
  154. {
  155. _scheduler->unschedule(_selector, _target);
  156. }
  157. // TimerTargetCallback
  158. TimerTargetCallback::TimerTargetCallback()
  159. : _target(nullptr)
  160. , _callback(nullptr)
  161. {
  162. }
  163. bool TimerTargetCallback::initWithCallback(Scheduler* scheduler, const ccSchedulerFunc& callback, void *target, const std::string& key, float seconds, unsigned int repeat, float delay)
  164. {
  165. _scheduler = scheduler;
  166. _target = target;
  167. _callback = callback;
  168. _key = key;
  169. setupTimerWithInterval(seconds, repeat, delay);
  170. return true;
  171. }
  172. void TimerTargetCallback::trigger(float dt)
  173. {
  174. if (_callback)
  175. {
  176. _callback(dt);
  177. }
  178. }
  179. void TimerTargetCallback::cancel()
  180. {
  181. _scheduler->unschedule(_key, _target);
  182. }
  183. #if CC_ENABLE_SCRIPT_BINDING
  184. // TimerScriptHandler
  185. bool TimerScriptHandler::initWithScriptHandler(int handler, float seconds)
  186. {
  187. _scriptHandler = handler;
  188. _elapsed = -1;
  189. _interval = seconds;
  190. return true;
  191. }
  192. void TimerScriptHandler::trigger(float dt)
  193. {
  194. if (0 != _scriptHandler)
  195. {
  196. SchedulerScriptData data(_scriptHandler,dt);
  197. ScriptEvent event(kScheduleEvent,&data);
  198. ScriptEngineManager::getInstance()->getScriptEngine()->sendEvent(&event);
  199. }
  200. }
  201. void TimerScriptHandler::cancel()
  202. {
  203. }
  204. #endif
  205. // implementation of Scheduler
  206. // Priority level reserved for system services.
  207. const int Scheduler::PRIORITY_SYSTEM = INT_MIN;
  208. // Minimum priority level for user scheduling.
  209. const int Scheduler::PRIORITY_NON_SYSTEM_MIN = PRIORITY_SYSTEM + 1;
  210. Scheduler::Scheduler(void)
  211. : _timeScale(1.0f)
  212. , _updatesNegList(nullptr)
  213. , _updates0List(nullptr)
  214. , _updatesPosList(nullptr)
  215. , _hashForUpdates(nullptr)
  216. , _hashForTimers(nullptr)
  217. , _currentTarget(nullptr)
  218. , _currentTargetSalvaged(false)
  219. , _updateHashLocked(false)
  220. #if CC_ENABLE_SCRIPT_BINDING
  221. , _scriptHandlerEntries(20)
  222. #endif
  223. {
  224. // I don't expect to have more than 30 functions to all per frame
  225. _functionsToPerform.reserve(30);
  226. }
  227. Scheduler::~Scheduler(void)
  228. {
  229. unscheduleAll();
  230. }
  231. void Scheduler::removeHashElement(_hashSelectorEntry *element)
  232. {
  233. ccArrayFree(element->timers);
  234. HASH_DEL(_hashForTimers, element);
  235. free(element);
  236. }
  237. void Scheduler::schedule(const ccSchedulerFunc& callback, void *target, float interval, bool paused, const std::string& key)
  238. {
  239. this->schedule(callback, target, interval, CC_REPEAT_FOREVER, 0.0f, paused, key);
  240. }
  241. void Scheduler::schedule(const ccSchedulerFunc& callback, void *target, float interval, unsigned int repeat, float delay, bool paused, const std::string& key)
  242. {
  243. CCASSERT(target, "Argument target must be non-nullptr");
  244. CCASSERT(!key.empty(), "key should not be empty!");
  245. tHashTimerEntry *element = nullptr;
  246. HASH_FIND_PTR(_hashForTimers, &target, element);
  247. if (! element)
  248. {
  249. element = (tHashTimerEntry *)calloc(sizeof(*element), 1);
  250. element->target = target;
  251. HASH_ADD_PTR(_hashForTimers, target, element);
  252. // Is this the 1st element ? Then set the pause level to all the selectors of this target
  253. element->paused = paused;
  254. }
  255. else
  256. {
  257. CCASSERT(element->paused == paused, "element's paused should be paused!");
  258. }
  259. if (element->timers == nullptr)
  260. {
  261. element->timers = ccArrayNew(10);
  262. }
  263. else
  264. {
  265. for (int i = 0; i < element->timers->num; ++i)
  266. {
  267. TimerTargetCallback *timer = dynamic_cast<TimerTargetCallback*>(element->timers->arr[i]);
  268. if (timer && !timer->isExhausted() && key == timer->getKey())
  269. {
  270. CCLOG("CCScheduler#schedule. Reiniting timer with interval %.4f, repeat %u, delay %.4f", interval, repeat, delay);
  271. timer->setupTimerWithInterval(interval, repeat, delay);
  272. return;
  273. }
  274. }
  275. ccArrayEnsureExtraCapacity(element->timers, 1);
  276. }
  277. TimerTargetCallback *timer = new (std::nothrow) TimerTargetCallback();
  278. timer->initWithCallback(this, callback, target, key, interval, repeat, delay);
  279. ccArrayAppendObject(element->timers, timer);
  280. timer->release();
  281. }
  282. void Scheduler::unschedule(const std::string &key, void *target)
  283. {
  284. // explicit handle nil arguments when removing an object
  285. if (target == nullptr || key.empty())
  286. {
  287. return;
  288. }
  289. //CCASSERT(target);
  290. //CCASSERT(selector);
  291. tHashTimerEntry *element = nullptr;
  292. HASH_FIND_PTR(_hashForTimers, &target, element);
  293. if (element)
  294. {
  295. for (int i = 0; i < element->timers->num; ++i)
  296. {
  297. TimerTargetCallback *timer = dynamic_cast<TimerTargetCallback*>(element->timers->arr[i]);
  298. if (timer && key == timer->getKey())
  299. {
  300. if (timer == element->currentTimer && (! timer->isAborted()))
  301. {
  302. timer->retain();
  303. timer->setAborted();
  304. }
  305. ccArrayRemoveObjectAtIndex(element->timers, i, true);
  306. // update timerIndex in case we are in tick:, looping over the actions
  307. if (element->timerIndex >= i)
  308. {
  309. element->timerIndex--;
  310. }
  311. if (element->timers->num == 0)
  312. {
  313. if (_currentTarget == element)
  314. {
  315. _currentTargetSalvaged = true;
  316. }
  317. else
  318. {
  319. removeHashElement(element);
  320. }
  321. }
  322. return;
  323. }
  324. }
  325. }
  326. }
  327. void Scheduler::priorityIn(tListEntry **list, const ccSchedulerFunc& callback, void *target, int priority, bool paused)
  328. {
  329. tListEntry *listElement = new (std::nothrow) tListEntry();
  330. listElement->callback = callback;
  331. listElement->target = target;
  332. listElement->priority = priority;
  333. listElement->paused = paused;
  334. listElement->next = listElement->prev = nullptr;
  335. listElement->markedForDeletion = false;
  336. // empty list ?
  337. if (! *list)
  338. {
  339. DL_APPEND(*list, listElement);
  340. }
  341. else
  342. {
  343. bool added = false;
  344. for (tListEntry *element = *list; element; element = element->next)
  345. {
  346. if (priority < element->priority)
  347. {
  348. if (element == *list)
  349. {
  350. DL_PREPEND(*list, listElement);
  351. }
  352. else
  353. {
  354. listElement->next = element;
  355. listElement->prev = element->prev;
  356. element->prev->next = listElement;
  357. element->prev = listElement;
  358. }
  359. added = true;
  360. break;
  361. }
  362. }
  363. // Not added? priority has the higher value. Append it.
  364. if (! added)
  365. {
  366. DL_APPEND(*list, listElement);
  367. }
  368. }
  369. // update hash entry for quick access
  370. tHashUpdateEntry *hashElement = (tHashUpdateEntry *)calloc(sizeof(*hashElement), 1);
  371. hashElement->target = target;
  372. hashElement->list = list;
  373. hashElement->entry = listElement;
  374. HASH_ADD_PTR(_hashForUpdates, target, hashElement);
  375. }
  376. void Scheduler::appendIn(_listEntry **list, const ccSchedulerFunc& callback, void *target, bool paused)
  377. {
  378. tListEntry *listElement = new (std::nothrow) tListEntry();
  379. listElement->callback = callback;
  380. listElement->target = target;
  381. listElement->paused = paused;
  382. listElement->priority = 0;
  383. listElement->markedForDeletion = false;
  384. DL_APPEND(*list, listElement);
  385. // update hash entry for quicker access
  386. tHashUpdateEntry *hashElement = (tHashUpdateEntry *)calloc(sizeof(*hashElement), 1);
  387. hashElement->target = target;
  388. hashElement->list = list;
  389. hashElement->entry = listElement;
  390. HASH_ADD_PTR(_hashForUpdates, target, hashElement);
  391. }
  392. void Scheduler::schedulePerFrame(const ccSchedulerFunc& callback, void *target, int priority, bool paused)
  393. {
  394. tHashUpdateEntry *hashElement = nullptr;
  395. HASH_FIND_PTR(_hashForUpdates, &target, hashElement);
  396. if (hashElement)
  397. {
  398. // change priority: should unschedule it first
  399. if (hashElement->entry->priority != priority)
  400. {
  401. unscheduleUpdate(target);
  402. }
  403. else
  404. {
  405. // don't add it again
  406. CCLOG("warning: don't update it again");
  407. return;
  408. }
  409. }
  410. // most of the updates are going to be 0, that's way there
  411. // is an special list for updates with priority 0
  412. if (priority == 0)
  413. {
  414. appendIn(&_updates0List, callback, target, paused);
  415. }
  416. else if (priority < 0)
  417. {
  418. priorityIn(&_updatesNegList, callback, target, priority, paused);
  419. }
  420. else
  421. {
  422. // priority > 0
  423. priorityIn(&_updatesPosList, callback, target, priority, paused);
  424. }
  425. }
  426. bool Scheduler::isScheduled(const std::string& key, const void *target) const
  427. {
  428. CCASSERT(!key.empty(), "Argument key must not be empty");
  429. CCASSERT(target, "Argument target must be non-nullptr");
  430. tHashTimerEntry *element = nullptr;
  431. HASH_FIND_PTR(_hashForTimers, &target, element);
  432. if (!element)
  433. {
  434. return false;
  435. }
  436. if (element->timers == nullptr)
  437. {
  438. return false;
  439. }
  440. for (int i = 0; i < element->timers->num; ++i)
  441. {
  442. TimerTargetCallback *timer = dynamic_cast<TimerTargetCallback*>(element->timers->arr[i]);
  443. if (timer && !timer->isExhausted() && key == timer->getKey())
  444. {
  445. return true;
  446. }
  447. }
  448. return false;
  449. }
  450. void Scheduler::removeUpdateFromHash(struct _listEntry *entry)
  451. {
  452. tHashUpdateEntry *element = nullptr;
  453. HASH_FIND_PTR(_hashForUpdates, &entry->target, element);
  454. if (element)
  455. {
  456. // list entry
  457. DL_DELETE(*element->list, element->entry);
  458. if (!_updateHashLocked)
  459. CC_SAFE_DELETE(element->entry);
  460. else
  461. {
  462. element->entry->markedForDeletion = true;
  463. _updateDeleteVector.push_back(element->entry);
  464. }
  465. // hash entry
  466. HASH_DEL(_hashForUpdates, element);
  467. free(element);
  468. }
  469. }
  470. void Scheduler::unscheduleUpdate(void *target)
  471. {
  472. if (target == nullptr)
  473. {
  474. return;
  475. }
  476. tHashUpdateEntry *element = nullptr;
  477. HASH_FIND_PTR(_hashForUpdates, &target, element);
  478. if (element)
  479. this->removeUpdateFromHash(element->entry);
  480. }
  481. void Scheduler::unscheduleAll(void)
  482. {
  483. unscheduleAllWithMinPriority(PRIORITY_SYSTEM);
  484. }
  485. void Scheduler::unscheduleAllWithMinPriority(int minPriority)
  486. {
  487. // Custom Selectors
  488. tHashTimerEntry *element = nullptr;
  489. tHashTimerEntry *nextElement = nullptr;
  490. for (element = _hashForTimers; element != nullptr;)
  491. {
  492. // element may be removed in unscheduleAllSelectorsForTarget
  493. nextElement = (tHashTimerEntry *)element->hh.next;
  494. unscheduleAllForTarget(element->target);
  495. element = nextElement;
  496. }
  497. // Updates selectors
  498. tListEntry *entry, *tmp;
  499. if(minPriority < 0)
  500. {
  501. DL_FOREACH_SAFE(_updatesNegList, entry, tmp)
  502. {
  503. if(entry->priority >= minPriority)
  504. {
  505. unscheduleUpdate(entry->target);
  506. }
  507. }
  508. }
  509. if(minPriority <= 0)
  510. {
  511. DL_FOREACH_SAFE(_updates0List, entry, tmp)
  512. {
  513. unscheduleUpdate(entry->target);
  514. }
  515. }
  516. DL_FOREACH_SAFE(_updatesPosList, entry, tmp)
  517. {
  518. if(entry->priority >= minPriority)
  519. {
  520. unscheduleUpdate(entry->target);
  521. }
  522. }
  523. #if CC_ENABLE_SCRIPT_BINDING
  524. _scriptHandlerEntries.clear();
  525. #endif
  526. }
  527. void Scheduler::unscheduleAllForTarget(void *target)
  528. {
  529. // explicit nullptr handling
  530. if (target == nullptr)
  531. {
  532. return;
  533. }
  534. // Custom Selectors
  535. tHashTimerEntry *element = nullptr;
  536. HASH_FIND_PTR(_hashForTimers, &target, element);
  537. if (element)
  538. {
  539. if (ccArrayContainsObject(element->timers, element->currentTimer)
  540. && (! element->currentTimer->isAborted()))
  541. {
  542. element->currentTimer->retain();
  543. element->currentTimer->setAborted();
  544. }
  545. ccArrayRemoveAllObjects(element->timers);
  546. if (_currentTarget == element)
  547. {
  548. _currentTargetSalvaged = true;
  549. }
  550. else
  551. {
  552. removeHashElement(element);
  553. }
  554. }
  555. // update selector
  556. unscheduleUpdate(target);
  557. }
  558. #if CC_ENABLE_SCRIPT_BINDING
  559. unsigned int Scheduler::scheduleScriptFunc(unsigned int handler, float interval, bool paused)
  560. {
  561. SchedulerScriptHandlerEntry* entry = SchedulerScriptHandlerEntry::create(handler, interval, paused);
  562. _scriptHandlerEntries.pushBack(entry);
  563. return entry->getEntryId();
  564. }
  565. void Scheduler::unscheduleScriptEntry(unsigned int scheduleScriptEntryID)
  566. {
  567. for (ssize_t i = _scriptHandlerEntries.size() - 1; i >= 0; i--)
  568. {
  569. SchedulerScriptHandlerEntry* entry = _scriptHandlerEntries.at(i);
  570. if (entry->getEntryId() == (int)scheduleScriptEntryID)
  571. {
  572. entry->markedForDeletion();
  573. break;
  574. }
  575. }
  576. }
  577. #endif
  578. void Scheduler::resumeTarget(void *target)
  579. {
  580. CCASSERT(target != nullptr, "target can't be nullptr!");
  581. // custom selectors
  582. tHashTimerEntry *element = nullptr;
  583. HASH_FIND_PTR(_hashForTimers, &target, element);
  584. if (element)
  585. {
  586. element->paused = false;
  587. }
  588. // update selector
  589. tHashUpdateEntry *elementUpdate = nullptr;
  590. HASH_FIND_PTR(_hashForUpdates, &target, elementUpdate);
  591. if (elementUpdate)
  592. {
  593. CCASSERT(elementUpdate->entry != nullptr, "elementUpdate's entry can't be nullptr!");
  594. elementUpdate->entry->paused = false;
  595. }
  596. }
  597. void Scheduler::pauseTarget(void *target)
  598. {
  599. CCASSERT(target != nullptr, "target can't be nullptr!");
  600. // custom selectors
  601. tHashTimerEntry *element = nullptr;
  602. HASH_FIND_PTR(_hashForTimers, &target, element);
  603. if (element)
  604. {
  605. element->paused = true;
  606. }
  607. // update selector
  608. tHashUpdateEntry *elementUpdate = nullptr;
  609. HASH_FIND_PTR(_hashForUpdates, &target, elementUpdate);
  610. if (elementUpdate)
  611. {
  612. CCASSERT(elementUpdate->entry != nullptr, "elementUpdate's entry can't be nullptr!");
  613. elementUpdate->entry->paused = true;
  614. }
  615. }
  616. bool Scheduler::isTargetPaused(void *target)
  617. {
  618. CCASSERT( target != nullptr, "target must be non nil" );
  619. // Custom selectors
  620. tHashTimerEntry *element = nullptr;
  621. HASH_FIND_PTR(_hashForTimers, &target, element);
  622. if( element )
  623. {
  624. return element->paused;
  625. }
  626. // We should check update selectors if target does not have custom selectors
  627. tHashUpdateEntry *elementUpdate = nullptr;
  628. HASH_FIND_PTR(_hashForUpdates, &target, elementUpdate);
  629. if ( elementUpdate )
  630. {
  631. return elementUpdate->entry->paused;
  632. }
  633. return false; // should never get here
  634. }
  635. std::set<void*> Scheduler::pauseAllTargets()
  636. {
  637. return pauseAllTargetsWithMinPriority(PRIORITY_SYSTEM);
  638. }
  639. std::set<void*> Scheduler::pauseAllTargetsWithMinPriority(int minPriority)
  640. {
  641. std::set<void*> idsWithSelectors;
  642. // Custom Selectors
  643. for(tHashTimerEntry *element = _hashForTimers; element != nullptr;
  644. element = (tHashTimerEntry*)element->hh.next)
  645. {
  646. element->paused = true;
  647. idsWithSelectors.insert(element->target);
  648. }
  649. // Updates selectors
  650. tListEntry *entry, *tmp;
  651. if(minPriority < 0)
  652. {
  653. DL_FOREACH_SAFE( _updatesNegList, entry, tmp )
  654. {
  655. if(entry->priority >= minPriority)
  656. {
  657. entry->paused = true;
  658. idsWithSelectors.insert(entry->target);
  659. }
  660. }
  661. }
  662. if(minPriority <= 0)
  663. {
  664. DL_FOREACH_SAFE( _updates0List, entry, tmp )
  665. {
  666. entry->paused = true;
  667. idsWithSelectors.insert(entry->target);
  668. }
  669. }
  670. DL_FOREACH_SAFE( _updatesPosList, entry, tmp )
  671. {
  672. if(entry->priority >= minPriority)
  673. {
  674. entry->paused = true;
  675. idsWithSelectors.insert(entry->target);
  676. }
  677. }
  678. return idsWithSelectors;
  679. }
  680. void Scheduler::resumeTargets(const std::set<void*>& targetsToResume)
  681. {
  682. for(const auto &obj : targetsToResume) {
  683. this->resumeTarget(obj);
  684. }
  685. }
  686. void Scheduler::performFunctionInCocosThread(std::function<void ()> function)
  687. {
  688. std::lock_guard<std::mutex> lock(_performMutex);
  689. _functionsToPerform.push_back(std::move(function));
  690. }
  691. void Scheduler::removeAllFunctionsToBePerformedInCocosThread()
  692. {
  693. std::unique_lock<std::mutex> lock(_performMutex);
  694. _functionsToPerform.clear();
  695. }
  696. // main loop
  697. void Scheduler::update(float dt)
  698. {
  699. _updateHashLocked = true;
  700. if (_timeScale != 1.0f)
  701. {
  702. dt *= _timeScale;
  703. }
  704. //
  705. // Selector callbacks
  706. //
  707. // Iterate over all the Updates' selectors
  708. tListEntry *entry, *tmp;
  709. // updates with priority < 0
  710. DL_FOREACH_SAFE(_updatesNegList, entry, tmp)
  711. {
  712. if ((! entry->paused) && (! entry->markedForDeletion))
  713. {
  714. entry->callback(dt);
  715. }
  716. }
  717. // updates with priority == 0
  718. DL_FOREACH_SAFE(_updates0List, entry, tmp)
  719. {
  720. if ((! entry->paused) && (! entry->markedForDeletion))
  721. {
  722. entry->callback(dt);
  723. }
  724. }
  725. // updates with priority > 0
  726. DL_FOREACH_SAFE(_updatesPosList, entry, tmp)
  727. {
  728. if ((! entry->paused) && (! entry->markedForDeletion))
  729. {
  730. entry->callback(dt);
  731. }
  732. }
  733. // Iterate over all the custom selectors
  734. for (tHashTimerEntry *elt = _hashForTimers; elt != nullptr; )
  735. {
  736. _currentTarget = elt;
  737. _currentTargetSalvaged = false;
  738. if (! _currentTarget->paused)
  739. {
  740. // The 'timers' array may change while inside this loop
  741. for (elt->timerIndex = 0; elt->timerIndex < elt->timers->num; ++(elt->timerIndex))
  742. {
  743. elt->currentTimer = (Timer*)(elt->timers->arr[elt->timerIndex]);
  744. CCASSERT
  745. ( !elt->currentTimer->isAborted(),
  746. "An aborted timer should not be updated" );
  747. elt->currentTimer->update(dt);
  748. if (elt->currentTimer->isAborted())
  749. {
  750. // The currentTimer told the remove itself. To prevent the timer from
  751. // accidentally deallocating itself before finishing its step, we retained
  752. // it. Now that step is done, it's safe to release it.
  753. elt->currentTimer->release();
  754. }
  755. elt->currentTimer = nullptr;
  756. }
  757. }
  758. // elt, at this moment, is still valid
  759. // so it is safe to ask this here (issue #490)
  760. elt = (tHashTimerEntry *)elt->hh.next;
  761. // only delete currentTarget if no actions were scheduled during the cycle (issue #481)
  762. if (_currentTargetSalvaged && _currentTarget->timers->num == 0)
  763. {
  764. removeHashElement(_currentTarget);
  765. }
  766. }
  767. // delete all updates that are removed in update
  768. for (auto &e : _updateDeleteVector)
  769. delete e;
  770. _updateDeleteVector.clear();
  771. _updateHashLocked = false;
  772. _currentTarget = nullptr;
  773. #if CC_ENABLE_SCRIPT_BINDING
  774. //
  775. // Script callbacks
  776. //
  777. // Iterate over all the script callbacks
  778. if (!_scriptHandlerEntries.empty())
  779. {
  780. for (auto i = _scriptHandlerEntries.size() - 1; i >= 0; i--)
  781. {
  782. SchedulerScriptHandlerEntry* eachEntry = _scriptHandlerEntries.at(i);
  783. if (eachEntry->isMarkedForDeletion())
  784. {
  785. _scriptHandlerEntries.erase(i);
  786. }
  787. else if (!eachEntry->isPaused())
  788. {
  789. eachEntry->getTimer()->update(dt);
  790. }
  791. }
  792. }
  793. #endif
  794. //
  795. // Functions allocated from another thread
  796. //
  797. // Testing size is faster than locking / unlocking.
  798. // And almost never there will be functions scheduled to be called.
  799. if( !_functionsToPerform.empty() ) {
  800. _performMutex.lock();
  801. // fixed #4123: Save the callback functions, they must be invoked after '_performMutex.unlock()', otherwise if new functions are added in callback, it will cause thread deadlock.
  802. auto temp = std::move(_functionsToPerform);
  803. _performMutex.unlock();
  804. for (const auto &function : temp) {
  805. function();
  806. }
  807. }
  808. }
  809. void Scheduler::schedule(SEL_SCHEDULE selector, Ref *target, float interval, unsigned int repeat, float delay, bool paused)
  810. {
  811. CCASSERT(target, "Argument target must be non-nullptr");
  812. tHashTimerEntry *element = nullptr;
  813. HASH_FIND_PTR(_hashForTimers, &target, element);
  814. if (! element)
  815. {
  816. element = (tHashTimerEntry *)calloc(sizeof(*element), 1);
  817. element->target = target;
  818. HASH_ADD_PTR(_hashForTimers, target, element);
  819. // Is this the 1st element ? Then set the pause level to all the selectors of this target
  820. element->paused = paused;
  821. }
  822. else
  823. {
  824. CCASSERT(element->paused == paused, "element's paused should be paused.");
  825. }
  826. if (element->timers == nullptr)
  827. {
  828. element->timers = ccArrayNew(10);
  829. }
  830. else
  831. {
  832. for (int i = 0; i < element->timers->num; ++i)
  833. {
  834. TimerTargetSelector *timer = dynamic_cast<TimerTargetSelector*>(element->timers->arr[i]);
  835. if (timer && !timer->isExhausted() && selector == timer->getSelector())
  836. {
  837. CCLOG("CCScheduler#schedule. Reiniting timer with interval %.4f, repeat %u, delay %.4f", interval, repeat, delay);
  838. timer->setupTimerWithInterval(interval, repeat, delay);
  839. return;
  840. }
  841. }
  842. ccArrayEnsureExtraCapacity(element->timers, 1);
  843. }
  844. TimerTargetSelector *timer = new (std::nothrow) TimerTargetSelector();
  845. timer->initWithSelector(this, selector, target, interval, repeat, delay);
  846. ccArrayAppendObject(element->timers, timer);
  847. timer->release();
  848. }
  849. void Scheduler::schedule(SEL_SCHEDULE selector, Ref *target, float interval, bool paused)
  850. {
  851. this->schedule(selector, target, interval, CC_REPEAT_FOREVER, 0.0f, paused);
  852. }
  853. bool Scheduler::isScheduled(SEL_SCHEDULE selector, const Ref *target) const
  854. {
  855. CCASSERT(selector, "Argument selector must be non-nullptr");
  856. CCASSERT(target, "Argument target must be non-nullptr");
  857. tHashTimerEntry *element = nullptr;
  858. HASH_FIND_PTR(_hashForTimers, &target, element);
  859. if (!element)
  860. {
  861. return false;
  862. }
  863. if (element->timers == nullptr)
  864. {
  865. return false;
  866. }
  867. for (int i = 0; i < element->timers->num; ++i)
  868. {
  869. TimerTargetSelector *timer = dynamic_cast<TimerTargetSelector*>(element->timers->arr[i]);
  870. if (timer && !timer->isExhausted() && selector == timer->getSelector())
  871. {
  872. return true;
  873. }
  874. }
  875. return false;
  876. }
  877. void Scheduler::unschedule(SEL_SCHEDULE selector, Ref *target)
  878. {
  879. // explicit handle nil arguments when removing an object
  880. if (target == nullptr || selector == nullptr)
  881. {
  882. return;
  883. }
  884. tHashTimerEntry *element = nullptr;
  885. HASH_FIND_PTR(_hashForTimers, &target, element);
  886. if (element)
  887. {
  888. for (int i = 0; i < element->timers->num; ++i)
  889. {
  890. TimerTargetSelector *timer = dynamic_cast<TimerTargetSelector*>(element->timers->arr[i]);
  891. if (timer && selector == timer->getSelector())
  892. {
  893. if (timer == element->currentTimer && !timer->isAborted())
  894. {
  895. timer->retain();
  896. timer->setAborted();
  897. }
  898. ccArrayRemoveObjectAtIndex(element->timers, i, true);
  899. // update timerIndex in case we are in tick:, looping over the actions
  900. if (element->timerIndex >= i)
  901. {
  902. element->timerIndex--;
  903. }
  904. if (element->timers->num == 0)
  905. {
  906. if (_currentTarget == element)
  907. {
  908. _currentTargetSalvaged = true;
  909. }
  910. else
  911. {
  912. removeHashElement(element);
  913. }
  914. }
  915. return;
  916. }
  917. }
  918. }
  919. }
  920. NS_CC_END