CCScheduler.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095
  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. }
  81. void Timer::update(float dt)
  82. {
  83. if (_elapsed == -1)
  84. {
  85. _elapsed = 0;
  86. _timesExecuted = 0;
  87. return;
  88. }
  89. // accumulate elapsed time
  90. _elapsed += dt;
  91. // deal with delay
  92. if (_useDelay)
  93. {
  94. if (_elapsed < _delay)
  95. {
  96. return;
  97. }
  98. trigger(_delay);
  99. _elapsed = _elapsed - _delay;
  100. _timesExecuted += 1;
  101. _useDelay = false;
  102. // after delay, the rest time should compare with interval
  103. if (!_runForever && _timesExecuted > _repeat)
  104. { //unschedule timer
  105. cancel();
  106. return;
  107. }
  108. }
  109. // if _interval == 0, should trigger once every frame
  110. float interval = (_interval > 0) ? _interval : _elapsed;
  111. while ((_elapsed >= interval) && !_aborted)
  112. {
  113. trigger(interval);
  114. _elapsed -= interval;
  115. _timesExecuted += 1;
  116. if (!_runForever && _timesExecuted > _repeat)
  117. {
  118. cancel();
  119. break;
  120. }
  121. if (_elapsed <= 0.f)
  122. {
  123. break;
  124. }
  125. }
  126. }
  127. // TimerTargetSelector
  128. TimerTargetSelector::TimerTargetSelector()
  129. : _target(nullptr)
  130. , _selector(nullptr)
  131. {
  132. }
  133. bool TimerTargetSelector::initWithSelector(Scheduler* scheduler, SEL_SCHEDULE selector, Ref* target, float seconds, unsigned int repeat, float delay)
  134. {
  135. _scheduler = scheduler;
  136. _target = target;
  137. _selector = selector;
  138. setupTimerWithInterval(seconds, repeat, delay);
  139. return true;
  140. }
  141. void TimerTargetSelector::trigger(float dt)
  142. {
  143. if (_target && _selector)
  144. {
  145. (_target->*_selector)(dt);
  146. }
  147. }
  148. void TimerTargetSelector::cancel()
  149. {
  150. _scheduler->unschedule(_selector, _target);
  151. }
  152. // TimerTargetCallback
  153. TimerTargetCallback::TimerTargetCallback()
  154. : _target(nullptr)
  155. , _callback(nullptr)
  156. {
  157. }
  158. bool TimerTargetCallback::initWithCallback(Scheduler* scheduler, const ccSchedulerFunc& callback, void *target, const std::string& key, float seconds, unsigned int repeat, float delay)
  159. {
  160. _scheduler = scheduler;
  161. _target = target;
  162. _callback = callback;
  163. _key = key;
  164. setupTimerWithInterval(seconds, repeat, delay);
  165. return true;
  166. }
  167. void TimerTargetCallback::trigger(float dt)
  168. {
  169. if (_callback)
  170. {
  171. _callback(dt);
  172. }
  173. }
  174. void TimerTargetCallback::cancel()
  175. {
  176. _scheduler->unschedule(_key, _target);
  177. }
  178. #if CC_ENABLE_SCRIPT_BINDING
  179. // TimerScriptHandler
  180. bool TimerScriptHandler::initWithScriptHandler(int handler, float seconds)
  181. {
  182. _scriptHandler = handler;
  183. _elapsed = -1;
  184. _interval = seconds;
  185. return true;
  186. }
  187. void TimerScriptHandler::trigger(float dt)
  188. {
  189. if (0 != _scriptHandler)
  190. {
  191. SchedulerScriptData data(_scriptHandler,dt);
  192. ScriptEvent event(kScheduleEvent,&data);
  193. ScriptEngineManager::getInstance()->getScriptEngine()->sendEvent(&event);
  194. }
  195. }
  196. void TimerScriptHandler::cancel()
  197. {
  198. }
  199. #endif
  200. // implementation of Scheduler
  201. // Priority level reserved for system services.
  202. const int Scheduler::PRIORITY_SYSTEM = INT_MIN;
  203. // Minimum priority level for user scheduling.
  204. const int Scheduler::PRIORITY_NON_SYSTEM_MIN = PRIORITY_SYSTEM + 1;
  205. Scheduler::Scheduler(void)
  206. : _timeScale(1.0f)
  207. , _updatesNegList(nullptr)
  208. , _updates0List(nullptr)
  209. , _updatesPosList(nullptr)
  210. , _hashForUpdates(nullptr)
  211. , _hashForTimers(nullptr)
  212. , _currentTarget(nullptr)
  213. , _currentTargetSalvaged(false)
  214. , _updateHashLocked(false)
  215. #if CC_ENABLE_SCRIPT_BINDING
  216. , _scriptHandlerEntries(20)
  217. #endif
  218. {
  219. // I don't expect to have more than 30 functions to all per frame
  220. _functionsToPerform.reserve(30);
  221. }
  222. Scheduler::~Scheduler(void)
  223. {
  224. unscheduleAll();
  225. }
  226. void Scheduler::removeHashElement(_hashSelectorEntry *element)
  227. {
  228. ccArrayFree(element->timers);
  229. HASH_DEL(_hashForTimers, element);
  230. free(element);
  231. }
  232. void Scheduler::schedule(const ccSchedulerFunc& callback, void *target, float interval, bool paused, const std::string& key)
  233. {
  234. this->schedule(callback, target, interval, CC_REPEAT_FOREVER, 0.0f, paused, key);
  235. }
  236. void Scheduler::schedule(const ccSchedulerFunc& callback, void *target, float interval, unsigned int repeat, float delay, bool paused, const std::string& key)
  237. {
  238. CCASSERT(target, "Argument target must be non-nullptr");
  239. CCASSERT(!key.empty(), "key should not be empty!");
  240. tHashTimerEntry *element = nullptr;
  241. HASH_FIND_PTR(_hashForTimers, &target, element);
  242. if (! element)
  243. {
  244. element = (tHashTimerEntry *)calloc(sizeof(*element), 1);
  245. element->target = target;
  246. HASH_ADD_PTR(_hashForTimers, target, element);
  247. // Is this the 1st element ? Then set the pause level to all the selectors of this target
  248. element->paused = paused;
  249. }
  250. else
  251. {
  252. CCASSERT(element->paused == paused, "element's paused should be paused!");
  253. }
  254. if (element->timers == nullptr)
  255. {
  256. element->timers = ccArrayNew(10);
  257. }
  258. else
  259. {
  260. for (int i = 0; i < element->timers->num; ++i)
  261. {
  262. TimerTargetCallback *timer = dynamic_cast<TimerTargetCallback*>(element->timers->arr[i]);
  263. if (timer && key == timer->getKey())
  264. {
  265. CCLOG("CCScheduler#scheduleSelector. Selector already scheduled. Updating interval from: %.4f to %.4f", timer->getInterval(), interval);
  266. timer->setInterval(interval);
  267. return;
  268. }
  269. }
  270. ccArrayEnsureExtraCapacity(element->timers, 1);
  271. }
  272. TimerTargetCallback *timer = new (std::nothrow) TimerTargetCallback();
  273. timer->initWithCallback(this, callback, target, key, interval, repeat, delay);
  274. ccArrayAppendObject(element->timers, timer);
  275. timer->release();
  276. }
  277. void Scheduler::unschedule(const std::string &key, void *target)
  278. {
  279. // explicit handle nil arguments when removing an object
  280. if (target == nullptr || key.empty())
  281. {
  282. return;
  283. }
  284. //CCASSERT(target);
  285. //CCASSERT(selector);
  286. tHashTimerEntry *element = nullptr;
  287. HASH_FIND_PTR(_hashForTimers, &target, element);
  288. if (element)
  289. {
  290. for (int i = 0; i < element->timers->num; ++i)
  291. {
  292. TimerTargetCallback *timer = dynamic_cast<TimerTargetCallback*>(element->timers->arr[i]);
  293. if (timer && key == timer->getKey())
  294. {
  295. if (timer == element->currentTimer && (! timer->isAborted()))
  296. {
  297. timer->retain();
  298. timer->setAborted();
  299. }
  300. ccArrayRemoveObjectAtIndex(element->timers, i, true);
  301. // update timerIndex in case we are in tick:, looping over the actions
  302. if (element->timerIndex >= i)
  303. {
  304. element->timerIndex--;
  305. }
  306. if (element->timers->num == 0)
  307. {
  308. if (_currentTarget == element)
  309. {
  310. _currentTargetSalvaged = true;
  311. }
  312. else
  313. {
  314. removeHashElement(element);
  315. }
  316. }
  317. return;
  318. }
  319. }
  320. }
  321. }
  322. void Scheduler::priorityIn(tListEntry **list, const ccSchedulerFunc& callback, void *target, int priority, bool paused)
  323. {
  324. tListEntry *listElement = new (std::nothrow) tListEntry();
  325. listElement->callback = callback;
  326. listElement->target = target;
  327. listElement->priority = priority;
  328. listElement->paused = paused;
  329. listElement->next = listElement->prev = nullptr;
  330. listElement->markedForDeletion = false;
  331. // empty list ?
  332. if (! *list)
  333. {
  334. DL_APPEND(*list, listElement);
  335. }
  336. else
  337. {
  338. bool added = false;
  339. for (tListEntry *element = *list; element; element = element->next)
  340. {
  341. if (priority < element->priority)
  342. {
  343. if (element == *list)
  344. {
  345. DL_PREPEND(*list, listElement);
  346. }
  347. else
  348. {
  349. listElement->next = element;
  350. listElement->prev = element->prev;
  351. element->prev->next = listElement;
  352. element->prev = listElement;
  353. }
  354. added = true;
  355. break;
  356. }
  357. }
  358. // Not added? priority has the higher value. Append it.
  359. if (! added)
  360. {
  361. DL_APPEND(*list, listElement);
  362. }
  363. }
  364. // update hash entry for quick access
  365. tHashUpdateEntry *hashElement = (tHashUpdateEntry *)calloc(sizeof(*hashElement), 1);
  366. hashElement->target = target;
  367. hashElement->list = list;
  368. hashElement->entry = listElement;
  369. HASH_ADD_PTR(_hashForUpdates, target, hashElement);
  370. }
  371. void Scheduler::appendIn(_listEntry **list, const ccSchedulerFunc& callback, void *target, bool paused)
  372. {
  373. tListEntry *listElement = new (std::nothrow) tListEntry();
  374. listElement->callback = callback;
  375. listElement->target = target;
  376. listElement->paused = paused;
  377. listElement->priority = 0;
  378. listElement->markedForDeletion = false;
  379. DL_APPEND(*list, listElement);
  380. // update hash entry for quicker access
  381. tHashUpdateEntry *hashElement = (tHashUpdateEntry *)calloc(sizeof(*hashElement), 1);
  382. hashElement->target = target;
  383. hashElement->list = list;
  384. hashElement->entry = listElement;
  385. HASH_ADD_PTR(_hashForUpdates, target, hashElement);
  386. }
  387. void Scheduler::schedulePerFrame(const ccSchedulerFunc& callback, void *target, int priority, bool paused)
  388. {
  389. tHashUpdateEntry *hashElement = nullptr;
  390. HASH_FIND_PTR(_hashForUpdates, &target, hashElement);
  391. if (hashElement)
  392. {
  393. // change priority: should unschedule it first
  394. if (hashElement->entry->priority != priority)
  395. {
  396. unscheduleUpdate(target);
  397. }
  398. else
  399. {
  400. // don't add it again
  401. CCLOG("warning: don't update it again");
  402. return;
  403. }
  404. }
  405. // most of the updates are going to be 0, that's way there
  406. // is an special list for updates with priority 0
  407. if (priority == 0)
  408. {
  409. appendIn(&_updates0List, callback, target, paused);
  410. }
  411. else if (priority < 0)
  412. {
  413. priorityIn(&_updatesNegList, callback, target, priority, paused);
  414. }
  415. else
  416. {
  417. // priority > 0
  418. priorityIn(&_updatesPosList, callback, target, priority, paused);
  419. }
  420. }
  421. bool Scheduler::isScheduled(const std::string& key, void *target)
  422. {
  423. CCASSERT(!key.empty(), "Argument key must not be empty");
  424. CCASSERT(target, "Argument target must be non-nullptr");
  425. tHashTimerEntry *element = nullptr;
  426. HASH_FIND_PTR(_hashForTimers, &target, element);
  427. if (!element)
  428. {
  429. return false;
  430. }
  431. if (element->timers == nullptr)
  432. {
  433. return false;
  434. }
  435. else
  436. {
  437. for (int i = 0; i < element->timers->num; ++i)
  438. {
  439. TimerTargetCallback *timer = dynamic_cast<TimerTargetCallback*>(element->timers->arr[i]);
  440. if (timer && key == timer->getKey())
  441. {
  442. return true;
  443. }
  444. }
  445. return false;
  446. }
  447. return false; // should never get here
  448. }
  449. void Scheduler::removeUpdateFromHash(struct _listEntry *entry)
  450. {
  451. tHashUpdateEntry *element = nullptr;
  452. HASH_FIND_PTR(_hashForUpdates, &entry->target, element);
  453. if (element)
  454. {
  455. // list entry
  456. DL_DELETE(*element->list, element->entry);
  457. if (!_updateHashLocked)
  458. CC_SAFE_DELETE(element->entry);
  459. else
  460. {
  461. element->entry->markedForDeletion = true;
  462. _updateDeleteVector.push_back(element->entry);
  463. }
  464. // hash entry
  465. HASH_DEL(_hashForUpdates, element);
  466. free(element);
  467. }
  468. }
  469. void Scheduler::unscheduleUpdate(void *target)
  470. {
  471. if (target == nullptr)
  472. {
  473. return;
  474. }
  475. tHashUpdateEntry *element = nullptr;
  476. HASH_FIND_PTR(_hashForUpdates, &target, element);
  477. if (element)
  478. this->removeUpdateFromHash(element->entry);
  479. }
  480. void Scheduler::unscheduleAll(void)
  481. {
  482. unscheduleAllWithMinPriority(PRIORITY_SYSTEM);
  483. }
  484. void Scheduler::unscheduleAllWithMinPriority(int minPriority)
  485. {
  486. // Custom Selectors
  487. tHashTimerEntry *element = nullptr;
  488. tHashTimerEntry *nextElement = nullptr;
  489. for (element = _hashForTimers; element != nullptr;)
  490. {
  491. // element may be removed in unscheduleAllSelectorsForTarget
  492. nextElement = (tHashTimerEntry *)element->hh.next;
  493. unscheduleAllForTarget(element->target);
  494. element = nextElement;
  495. }
  496. // Updates selectors
  497. tListEntry *entry, *tmp;
  498. if(minPriority < 0)
  499. {
  500. DL_FOREACH_SAFE(_updatesNegList, entry, tmp)
  501. {
  502. if(entry->priority >= minPriority)
  503. {
  504. unscheduleUpdate(entry->target);
  505. }
  506. }
  507. }
  508. if(minPriority <= 0)
  509. {
  510. DL_FOREACH_SAFE(_updates0List, entry, tmp)
  511. {
  512. unscheduleUpdate(entry->target);
  513. }
  514. }
  515. DL_FOREACH_SAFE(_updatesPosList, entry, tmp)
  516. {
  517. if(entry->priority >= minPriority)
  518. {
  519. unscheduleUpdate(entry->target);
  520. }
  521. }
  522. #if CC_ENABLE_SCRIPT_BINDING
  523. _scriptHandlerEntries.clear();
  524. #endif
  525. }
  526. void Scheduler::unscheduleAllForTarget(void *target)
  527. {
  528. // explicit nullptr handling
  529. if (target == nullptr)
  530. {
  531. return;
  532. }
  533. // Custom Selectors
  534. tHashTimerEntry *element = nullptr;
  535. HASH_FIND_PTR(_hashForTimers, &target, element);
  536. if (element)
  537. {
  538. if (ccArrayContainsObject(element->timers, element->currentTimer)
  539. && (! element->currentTimer->isAborted()))
  540. {
  541. element->currentTimer->retain();
  542. element->currentTimer->setAborted();
  543. }
  544. ccArrayRemoveAllObjects(element->timers);
  545. if (_currentTarget == element)
  546. {
  547. _currentTargetSalvaged = true;
  548. }
  549. else
  550. {
  551. removeHashElement(element);
  552. }
  553. }
  554. // update selector
  555. unscheduleUpdate(target);
  556. }
  557. #if CC_ENABLE_SCRIPT_BINDING
  558. unsigned int Scheduler::scheduleScriptFunc(unsigned int handler, float interval, bool paused)
  559. {
  560. SchedulerScriptHandlerEntry* entry = SchedulerScriptHandlerEntry::create(handler, interval, paused);
  561. _scriptHandlerEntries.pushBack(entry);
  562. return entry->getEntryId();
  563. }
  564. void Scheduler::unscheduleScriptEntry(unsigned int scheduleScriptEntryID)
  565. {
  566. for (ssize_t i = _scriptHandlerEntries.size() - 1; i >= 0; i--)
  567. {
  568. SchedulerScriptHandlerEntry* entry = _scriptHandlerEntries.at(i);
  569. if (entry->getEntryId() == (int)scheduleScriptEntryID)
  570. {
  571. entry->markedForDeletion();
  572. break;
  573. }
  574. }
  575. }
  576. #endif
  577. void Scheduler::resumeTarget(void *target)
  578. {
  579. CCASSERT(target != nullptr, "target can't be nullptr!");
  580. // custom selectors
  581. tHashTimerEntry *element = nullptr;
  582. HASH_FIND_PTR(_hashForTimers, &target, element);
  583. if (element)
  584. {
  585. element->paused = false;
  586. }
  587. // update selector
  588. tHashUpdateEntry *elementUpdate = nullptr;
  589. HASH_FIND_PTR(_hashForUpdates, &target, elementUpdate);
  590. if (elementUpdate)
  591. {
  592. CCASSERT(elementUpdate->entry != nullptr, "elementUpdate's entry can't be nullptr!");
  593. elementUpdate->entry->paused = false;
  594. }
  595. }
  596. void Scheduler::pauseTarget(void *target)
  597. {
  598. CCASSERT(target != nullptr, "target can't be nullptr!");
  599. // custom selectors
  600. tHashTimerEntry *element = nullptr;
  601. HASH_FIND_PTR(_hashForTimers, &target, element);
  602. if (element)
  603. {
  604. element->paused = true;
  605. }
  606. // update selector
  607. tHashUpdateEntry *elementUpdate = nullptr;
  608. HASH_FIND_PTR(_hashForUpdates, &target, elementUpdate);
  609. if (elementUpdate)
  610. {
  611. CCASSERT(elementUpdate->entry != nullptr, "elementUpdate's entry can't be nullptr!");
  612. elementUpdate->entry->paused = true;
  613. }
  614. }
  615. bool Scheduler::isTargetPaused(void *target)
  616. {
  617. CCASSERT( target != nullptr, "target must be non nil" );
  618. // Custom selectors
  619. tHashTimerEntry *element = nullptr;
  620. HASH_FIND_PTR(_hashForTimers, &target, element);
  621. if( element )
  622. {
  623. return element->paused;
  624. }
  625. // We should check update selectors if target does not have custom selectors
  626. tHashUpdateEntry *elementUpdate = nullptr;
  627. HASH_FIND_PTR(_hashForUpdates, &target, elementUpdate);
  628. if ( elementUpdate )
  629. {
  630. return elementUpdate->entry->paused;
  631. }
  632. return false; // should never get here
  633. }
  634. std::set<void*> Scheduler::pauseAllTargets()
  635. {
  636. return pauseAllTargetsWithMinPriority(PRIORITY_SYSTEM);
  637. }
  638. std::set<void*> Scheduler::pauseAllTargetsWithMinPriority(int minPriority)
  639. {
  640. std::set<void*> idsWithSelectors;
  641. // Custom Selectors
  642. for(tHashTimerEntry *element = _hashForTimers; element != nullptr;
  643. element = (tHashTimerEntry*)element->hh.next)
  644. {
  645. element->paused = true;
  646. idsWithSelectors.insert(element->target);
  647. }
  648. // Updates selectors
  649. tListEntry *entry, *tmp;
  650. if(minPriority < 0)
  651. {
  652. DL_FOREACH_SAFE( _updatesNegList, entry, tmp )
  653. {
  654. if(entry->priority >= minPriority)
  655. {
  656. entry->paused = true;
  657. idsWithSelectors.insert(entry->target);
  658. }
  659. }
  660. }
  661. if(minPriority <= 0)
  662. {
  663. DL_FOREACH_SAFE( _updates0List, entry, tmp )
  664. {
  665. entry->paused = true;
  666. idsWithSelectors.insert(entry->target);
  667. }
  668. }
  669. DL_FOREACH_SAFE( _updatesPosList, entry, tmp )
  670. {
  671. if(entry->priority >= minPriority)
  672. {
  673. entry->paused = true;
  674. idsWithSelectors.insert(entry->target);
  675. }
  676. }
  677. return idsWithSelectors;
  678. }
  679. void Scheduler::resumeTargets(const std::set<void*>& targetsToResume)
  680. {
  681. for(const auto &obj : targetsToResume) {
  682. this->resumeTarget(obj);
  683. }
  684. }
  685. void Scheduler::performFunctionInCocosThread(const std::function<void ()> &function)
  686. {
  687. _performMutex.lock();
  688. _functionsToPerform.push_back(function);
  689. _performMutex.unlock();
  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 = _functionsToPerform;
  803. _functionsToPerform.clear();
  804. _performMutex.unlock();
  805. for( const auto &function : temp ) {
  806. function();
  807. }
  808. }
  809. }
  810. void Scheduler::schedule(SEL_SCHEDULE selector, Ref *target, float interval, unsigned int repeat, float delay, bool paused)
  811. {
  812. CCASSERT(target, "Argument target must be non-nullptr");
  813. tHashTimerEntry *element = nullptr;
  814. HASH_FIND_PTR(_hashForTimers, &target, element);
  815. if (! element)
  816. {
  817. element = (tHashTimerEntry *)calloc(sizeof(*element), 1);
  818. element->target = target;
  819. HASH_ADD_PTR(_hashForTimers, target, element);
  820. // Is this the 1st element ? Then set the pause level to all the selectors of this target
  821. element->paused = paused;
  822. }
  823. else
  824. {
  825. CCASSERT(element->paused == paused, "element's paused should be paused.");
  826. }
  827. if (element->timers == nullptr)
  828. {
  829. element->timers = ccArrayNew(10);
  830. }
  831. else
  832. {
  833. for (int i = 0; i < element->timers->num; ++i)
  834. {
  835. TimerTargetSelector *timer = dynamic_cast<TimerTargetSelector*>(element->timers->arr[i]);
  836. if (timer && selector == timer->getSelector())
  837. {
  838. CCLOG("CCScheduler#scheduleSelector. Selector already scheduled. Updating interval from: %.4f to %.4f", timer->getInterval(), interval);
  839. timer->setInterval(interval);
  840. return;
  841. }
  842. }
  843. ccArrayEnsureExtraCapacity(element->timers, 1);
  844. }
  845. TimerTargetSelector *timer = new (std::nothrow) TimerTargetSelector();
  846. timer->initWithSelector(this, selector, target, interval, repeat, delay);
  847. ccArrayAppendObject(element->timers, timer);
  848. timer->release();
  849. }
  850. void Scheduler::schedule(SEL_SCHEDULE selector, Ref *target, float interval, bool paused)
  851. {
  852. this->schedule(selector, target, interval, CC_REPEAT_FOREVER, 0.0f, paused);
  853. }
  854. bool Scheduler::isScheduled(SEL_SCHEDULE selector, Ref *target)
  855. {
  856. CCASSERT(selector, "Argument selector must be non-nullptr");
  857. CCASSERT(target, "Argument target must be non-nullptr");
  858. tHashTimerEntry *element = nullptr;
  859. HASH_FIND_PTR(_hashForTimers, &target, element);
  860. if (!element)
  861. {
  862. return false;
  863. }
  864. if (element->timers == nullptr)
  865. {
  866. return false;
  867. }
  868. else
  869. {
  870. for (int i = 0; i < element->timers->num; ++i)
  871. {
  872. TimerTargetSelector *timer = dynamic_cast<TimerTargetSelector*>(element->timers->arr[i]);
  873. if (timer && selector == timer->getSelector())
  874. {
  875. return true;
  876. }
  877. }
  878. return false;
  879. }
  880. return false; // should never get here
  881. }
  882. void Scheduler::unschedule(SEL_SCHEDULE selector, Ref *target)
  883. {
  884. // explicit handle nil arguments when removing an object
  885. if (target == nullptr || selector == nullptr)
  886. {
  887. return;
  888. }
  889. tHashTimerEntry *element = nullptr;
  890. HASH_FIND_PTR(_hashForTimers, &target, element);
  891. if (element)
  892. {
  893. for (int i = 0; i < element->timers->num; ++i)
  894. {
  895. TimerTargetSelector *timer = dynamic_cast<TimerTargetSelector*>(element->timers->arr[i]);
  896. if (timer && selector == timer->getSelector())
  897. {
  898. if (timer == element->currentTimer && (! timer->isAborted()))
  899. {
  900. timer->retain();
  901. timer->setAborted();
  902. }
  903. ccArrayRemoveObjectAtIndex(element->timers, i, true);
  904. // update timerIndex in case we are in tick:, looping over the actions
  905. if (element->timerIndex >= i)
  906. {
  907. element->timerIndex--;
  908. }
  909. if (element->timers->num == 0)
  910. {
  911. if (_currentTarget == element)
  912. {
  913. _currentTargetSalvaged = true;
  914. }
  915. else
  916. {
  917. removeHashElement(element);
  918. }
  919. }
  920. return;
  921. }
  922. }
  923. }
  924. }
  925. NS_CC_END