Cristiano Barbosa / microbit-dal2

security manager conflict commented 2

Dependencies:   BLE_API mbed-dev-bin nRF51822

Fork of microbit-dal by Lancaster University

inc/types/RefCounted.h@74:8cb1c4aa4527, 2018-01-26 (annotated)

Committer:
cristianobarbosa
Date:
Fri Jan 26 14:11:55 2018 +0000
Revision:
74:8cb1c4aa4527
Parent:
1:8aa5cdb4ab67 
sender

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jonathan Austin 1:8aa5cdb4ab67 1 /*
Jonathan Austin 1:8aa5cdb4ab67 2 The MIT License (MIT)
Jonathan Austin 1:8aa5cdb4ab67 3
Jonathan Austin 1:8aa5cdb4ab67 4 Copyright (c) 2016 British Broadcasting Corporation.
Jonathan Austin 1:8aa5cdb4ab67 5 This software is provided by Lancaster University by arrangement with the BBC.
Jonathan Austin 1:8aa5cdb4ab67 6
Jonathan Austin 1:8aa5cdb4ab67 7 Permission is hereby granted, free of charge, to any person obtaining a
Jonathan Austin 1:8aa5cdb4ab67 8 copy of this software and associated documentation files (the "Software"),
Jonathan Austin 1:8aa5cdb4ab67 9 to deal in the Software without restriction, including without limitation
Jonathan Austin 1:8aa5cdb4ab67 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
Jonathan Austin 1:8aa5cdb4ab67 11 and/or sell copies of the Software, and to permit persons to whom the
Jonathan Austin 1:8aa5cdb4ab67 12 Software is furnished to do so, subject to the following conditions:
Jonathan Austin 1:8aa5cdb4ab67 13
Jonathan Austin 1:8aa5cdb4ab67 14 The above copyright notice and this permission notice shall be included in
Jonathan Austin 1:8aa5cdb4ab67 15 all copies or substantial portions of the Software.
Jonathan Austin 1:8aa5cdb4ab67 16
Jonathan Austin 1:8aa5cdb4ab67 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Jonathan Austin 1:8aa5cdb4ab67 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jonathan Austin 1:8aa5cdb4ab67 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
Jonathan Austin 1:8aa5cdb4ab67 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Jonathan Austin 1:8aa5cdb4ab67 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 23 DEALINGS IN THE SOFTWARE.
Jonathan Austin 1:8aa5cdb4ab67 24 */
Jonathan Austin 1:8aa5cdb4ab67 25
Jonathan Austin 1:8aa5cdb4ab67 26 #ifndef REF_COUNTED_H
Jonathan Austin 1:8aa5cdb4ab67 27 #define REF_COUNTED_H
Jonathan Austin 1:8aa5cdb4ab67 28
Jonathan Austin 1:8aa5cdb4ab67 29 #include "mbed.h"
Jonathan Austin 1:8aa5cdb4ab67 30 #include "MicroBitConfig.h"
Jonathan Austin 1:8aa5cdb4ab67 31 #include "MicroBitDevice.h"
Jonathan Austin 1:8aa5cdb4ab67 32
Jonathan Austin 1:8aa5cdb4ab67 33 /**
Jonathan Austin 1:8aa5cdb4ab67 34 * Base class for payload for ref-counted objects. Used by ManagedString and MicroBitImage.
Jonathan Austin 1:8aa5cdb4ab67 35 * There is no constructor, as this struct is typically malloc()ed.
Jonathan Austin 1:8aa5cdb4ab67 36 */
Jonathan Austin 1:8aa5cdb4ab67 37 struct RefCounted
Jonathan Austin 1:8aa5cdb4ab67 38 {
Jonathan Austin 1:8aa5cdb4ab67 39 public:
Jonathan Austin 1:8aa5cdb4ab67 40
Jonathan Austin 1:8aa5cdb4ab67 41 /**
Jonathan Austin 1:8aa5cdb4ab67 42 * The high 15 bits hold the number of outstanding references. The lowest bit is always 1
Jonathan Austin 1:8aa5cdb4ab67 43 * to make sure it doesn't look like vtable.
Jonathan Austin 1:8aa5cdb4ab67 44 * Should never be even or one (object should be deleted then).
Jonathan Austin 1:8aa5cdb4ab67 45 * When it's set to 0xffff, it means the object sits in flash and should not be counted.
Jonathan Austin 1:8aa5cdb4ab67 46 */
Jonathan Austin 1:8aa5cdb4ab67 47 uint16_t refCount;
Jonathan Austin 1:8aa5cdb4ab67 48
Jonathan Austin 1:8aa5cdb4ab67 49 /**
Jonathan Austin 1:8aa5cdb4ab67 50 * Increment reference count.
Jonathan Austin 1:8aa5cdb4ab67 51 */
Jonathan Austin 1:8aa5cdb4ab67 52 void incr();
Jonathan Austin 1:8aa5cdb4ab67 53
Jonathan Austin 1:8aa5cdb4ab67 54 /**
Jonathan Austin 1:8aa5cdb4ab67 55 * Decrement reference count.
Jonathan Austin 1:8aa5cdb4ab67 56 */
Jonathan Austin 1:8aa5cdb4ab67 57 void decr();
Jonathan Austin 1:8aa5cdb4ab67 58
Jonathan Austin 1:8aa5cdb4ab67 59 /**
Jonathan Austin 1:8aa5cdb4ab67 60 * Initializes for one outstanding reference.
Jonathan Austin 1:8aa5cdb4ab67 61 */
Jonathan Austin 1:8aa5cdb4ab67 62 void init();
Jonathan Austin 1:8aa5cdb4ab67 63
Jonathan Austin 1:8aa5cdb4ab67 64 /**
Jonathan Austin 1:8aa5cdb4ab67 65 * Checks if the object resides in flash memory.
Jonathan Austin 1:8aa5cdb4ab67 66 *
Jonathan Austin 1:8aa5cdb4ab67 67 * @return true if the object resides in flash memory, false otherwise.
Jonathan Austin 1:8aa5cdb4ab67 68 */
Jonathan Austin 1:8aa5cdb4ab67 69 bool isReadOnly();
Jonathan Austin 1:8aa5cdb4ab67 70 };
Jonathan Austin 1:8aa5cdb4ab67 71
Jonathan Austin 1:8aa5cdb4ab67 72 #endif