v-16
RecordText.h@0:89e2c8a57572, 2017-12-12 (annotated)
- Committer:
- DuyLionTran
- Date:
- Tue Dec 12 15:58:23 2017 +0000
- Revision:
- 0:89e2c8a57572
version 1.6
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
DuyLionTran | 0:89e2c8a57572 | 1 | /** |
DuyLionTran | 0:89e2c8a57572 | 2 | ****************************************************************************** |
DuyLionTran | 0:89e2c8a57572 | 3 | * @file RecordText.h |
DuyLionTran | 0:89e2c8a57572 | 4 | * @author ST / Central Labs |
DuyLionTran | 0:89e2c8a57572 | 5 | * @version V2.0.0 |
DuyLionTran | 0:89e2c8a57572 | 6 | * @date 28 Apr 2017 |
DuyLionTran | 0:89e2c8a57572 | 7 | * @brief {@link Record} containing a simple text |
DuyLionTran | 0:89e2c8a57572 | 8 | ****************************************************************************** |
DuyLionTran | 0:89e2c8a57572 | 9 | * @attention |
DuyLionTran | 0:89e2c8a57572 | 10 | * |
DuyLionTran | 0:89e2c8a57572 | 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
DuyLionTran | 0:89e2c8a57572 | 12 | * |
DuyLionTran | 0:89e2c8a57572 | 13 | * Redistribution and use in source and binary forms, with or without modification, |
DuyLionTran | 0:89e2c8a57572 | 14 | * are permitted provided that the following conditions are met: |
DuyLionTran | 0:89e2c8a57572 | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
DuyLionTran | 0:89e2c8a57572 | 16 | * this list of conditions and the following disclaimer. |
DuyLionTran | 0:89e2c8a57572 | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
DuyLionTran | 0:89e2c8a57572 | 18 | * this list of conditions and the following disclaimer in the documentation |
DuyLionTran | 0:89e2c8a57572 | 19 | * and/or other materials provided with the distribution. |
DuyLionTran | 0:89e2c8a57572 | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
DuyLionTran | 0:89e2c8a57572 | 21 | * may be used to endorse or promote products derived from this software |
DuyLionTran | 0:89e2c8a57572 | 22 | * without specific prior written permission. |
DuyLionTran | 0:89e2c8a57572 | 23 | * |
DuyLionTran | 0:89e2c8a57572 | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
DuyLionTran | 0:89e2c8a57572 | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
DuyLionTran | 0:89e2c8a57572 | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
DuyLionTran | 0:89e2c8a57572 | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
DuyLionTran | 0:89e2c8a57572 | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
DuyLionTran | 0:89e2c8a57572 | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
DuyLionTran | 0:89e2c8a57572 | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
DuyLionTran | 0:89e2c8a57572 | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
DuyLionTran | 0:89e2c8a57572 | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
DuyLionTran | 0:89e2c8a57572 | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
DuyLionTran | 0:89e2c8a57572 | 34 | * |
DuyLionTran | 0:89e2c8a57572 | 35 | ****************************************************************************** |
DuyLionTran | 0:89e2c8a57572 | 36 | */ |
DuyLionTran | 0:89e2c8a57572 | 37 | |
DuyLionTran | 0:89e2c8a57572 | 38 | |
DuyLionTran | 0:89e2c8a57572 | 39 | #ifndef NDEFLIB_RECORDTYPE_RECORDTEXT_H_ |
DuyLionTran | 0:89e2c8a57572 | 40 | #define NDEFLIB_RECORDTYPE_RECORDTEXT_H_ |
DuyLionTran | 0:89e2c8a57572 | 41 | #include <string> |
DuyLionTran | 0:89e2c8a57572 | 42 | #include <NDefLib/Record.h> |
DuyLionTran | 0:89e2c8a57572 | 43 | |
DuyLionTran | 0:89e2c8a57572 | 44 | namespace NDefLib { |
DuyLionTran | 0:89e2c8a57572 | 45 | |
DuyLionTran | 0:89e2c8a57572 | 46 | /** |
DuyLionTran | 0:89e2c8a57572 | 47 | * {@link Record} containing a simple text. |
DuyLionTran | 0:89e2c8a57572 | 48 | * @par The text is copied inside the class. |
DuyLionTran | 0:89e2c8a57572 | 49 | */ |
DuyLionTran | 0:89e2c8a57572 | 50 | class RecordText: public Record { |
DuyLionTran | 0:89e2c8a57572 | 51 | public: |
DuyLionTran | 0:89e2c8a57572 | 52 | |
DuyLionTran | 0:89e2c8a57572 | 53 | /** |
DuyLionTran | 0:89e2c8a57572 | 54 | * Read a recordText from a buffer. |
DuyLionTran | 0:89e2c8a57572 | 55 | * @param header Record header. |
DuyLionTran | 0:89e2c8a57572 | 56 | * @param buffer Buffer to read the record content from. |
DuyLionTran | 0:89e2c8a57572 | 57 | * @return a record of type Text or NULL if it was not possible build this type of record |
DuyLionTran | 0:89e2c8a57572 | 58 | * @par User is in charge of freeing the pointer returned by this function. |
DuyLionTran | 0:89e2c8a57572 | 59 | */ |
DuyLionTran | 0:89e2c8a57572 | 60 | static RecordText* parse(const RecordHeader &header, |
DuyLionTran | 0:89e2c8a57572 | 61 | const uint8_t * const buffer); |
DuyLionTran | 0:89e2c8a57572 | 62 | |
DuyLionTran | 0:89e2c8a57572 | 63 | /** |
DuyLionTran | 0:89e2c8a57572 | 64 | * Set the type of encoding used to store the text data |
DuyLionTran | 0:89e2c8a57572 | 65 | */ |
DuyLionTran | 0:89e2c8a57572 | 66 | typedef enum { |
DuyLionTran | 0:89e2c8a57572 | 67 | UTF8, //!< UTF8 |
DuyLionTran | 0:89e2c8a57572 | 68 | UTF16,//!< UTF16 |
DuyLionTran | 0:89e2c8a57572 | 69 | } TextEncoding; |
DuyLionTran | 0:89e2c8a57572 | 70 | |
DuyLionTran | 0:89e2c8a57572 | 71 | /** |
DuyLionTran | 0:89e2c8a57572 | 72 | * Build a utf8, English text record. |
DuyLionTran | 0:89e2c8a57572 | 73 | * @param text Text to store in the record. |
DuyLionTran | 0:89e2c8a57572 | 74 | */ |
DuyLionTran | 0:89e2c8a57572 | 75 | explicit RecordText(const std::string &text=""); |
DuyLionTran | 0:89e2c8a57572 | 76 | |
DuyLionTran | 0:89e2c8a57572 | 77 | /** |
DuyLionTran | 0:89e2c8a57572 | 78 | * Build a text record. |
DuyLionTran | 0:89e2c8a57572 | 79 | * @param encoding Rype used to store the message. |
DuyLionTran | 0:89e2c8a57572 | 80 | * @param language Language used in the text. |
DuyLionTran | 0:89e2c8a57572 | 81 | * @param Text record text. |
DuyLionTran | 0:89e2c8a57572 | 82 | */ |
DuyLionTran | 0:89e2c8a57572 | 83 | RecordText(const TextEncoding encoding, const std::string &language, |
DuyLionTran | 0:89e2c8a57572 | 84 | const std::string &text); |
DuyLionTran | 0:89e2c8a57572 | 85 | |
DuyLionTran | 0:89e2c8a57572 | 86 | /** |
DuyLionTran | 0:89e2c8a57572 | 87 | * Get the record type. |
DuyLionTran | 0:89e2c8a57572 | 88 | * @return TYPE_TEXT |
DuyLionTran | 0:89e2c8a57572 | 89 | */ |
DuyLionTran | 0:89e2c8a57572 | 90 | virtual RecordType_t get_type() const { |
DuyLionTran | 0:89e2c8a57572 | 91 | return TYPE_TEXT; |
DuyLionTran | 0:89e2c8a57572 | 92 | } //getType |
DuyLionTran | 0:89e2c8a57572 | 93 | |
DuyLionTran | 0:89e2c8a57572 | 94 | /** |
DuyLionTran | 0:89e2c8a57572 | 95 | * Get the text inside this record. |
DuyLionTran | 0:89e2c8a57572 | 96 | * @return the text content |
DuyLionTran | 0:89e2c8a57572 | 97 | */ |
DuyLionTran | 0:89e2c8a57572 | 98 | const std::string& get_text() const { |
DuyLionTran | 0:89e2c8a57572 | 99 | return mText; |
DuyLionTran | 0:89e2c8a57572 | 100 | } |
DuyLionTran | 0:89e2c8a57572 | 101 | |
DuyLionTran | 0:89e2c8a57572 | 102 | /** |
DuyLionTran | 0:89e2c8a57572 | 103 | * Change the text content. |
DuyLionTran | 0:89e2c8a57572 | 104 | * @param text New text to store. |
DuyLionTran | 0:89e2c8a57572 | 105 | */ |
DuyLionTran | 0:89e2c8a57572 | 106 | void set_text (const std::string &text){ |
DuyLionTran | 0:89e2c8a57572 | 107 | mText = text; |
DuyLionTran | 0:89e2c8a57572 | 108 | update_playload_length(); |
DuyLionTran | 0:89e2c8a57572 | 109 | } |
DuyLionTran | 0:89e2c8a57572 | 110 | |
DuyLionTran | 0:89e2c8a57572 | 111 | /** |
DuyLionTran | 0:89e2c8a57572 | 112 | * Get the language used in the text. |
DuyLionTran | 0:89e2c8a57572 | 113 | * @return Language used in the text. |
DuyLionTran | 0:89e2c8a57572 | 114 | */ |
DuyLionTran | 0:89e2c8a57572 | 115 | const std::string& get_language()const{ |
DuyLionTran | 0:89e2c8a57572 | 116 | return mLanguage; |
DuyLionTran | 0:89e2c8a57572 | 117 | } |
DuyLionTran | 0:89e2c8a57572 | 118 | |
DuyLionTran | 0:89e2c8a57572 | 119 | /** |
DuyLionTran | 0:89e2c8a57572 | 120 | * Get the encoding used to store the text. |
DuyLionTran | 0:89e2c8a57572 | 121 | * @return get the encoding used to store the text |
DuyLionTran | 0:89e2c8a57572 | 122 | */ |
DuyLionTran | 0:89e2c8a57572 | 123 | TextEncoding get_encoding()const{ |
DuyLionTran | 0:89e2c8a57572 | 124 | return mEncode; |
DuyLionTran | 0:89e2c8a57572 | 125 | } |
DuyLionTran | 0:89e2c8a57572 | 126 | |
DuyLionTran | 0:89e2c8a57572 | 127 | /** |
DuyLionTran | 0:89e2c8a57572 | 128 | * Compare 2 objects. |
DuyLionTran | 0:89e2c8a57572 | 129 | * @return true if the objects have the same encoding,language and text |
DuyLionTran | 0:89e2c8a57572 | 130 | */ |
DuyLionTran | 0:89e2c8a57572 | 131 | bool operator==(const RecordText &other)const{ |
DuyLionTran | 0:89e2c8a57572 | 132 | return mTextStatus == other.mTextStatus && |
DuyLionTran | 0:89e2c8a57572 | 133 | mLanguage == other.mLanguage && |
DuyLionTran | 0:89e2c8a57572 | 134 | mText == other.mText; |
DuyLionTran | 0:89e2c8a57572 | 135 | |
DuyLionTran | 0:89e2c8a57572 | 136 | } |
DuyLionTran | 0:89e2c8a57572 | 137 | |
DuyLionTran | 0:89e2c8a57572 | 138 | virtual uint16_t write(uint8_t *buffer); |
DuyLionTran | 0:89e2c8a57572 | 139 | virtual ~RecordText() { }; |
DuyLionTran | 0:89e2c8a57572 | 140 | |
DuyLionTran | 0:89e2c8a57572 | 141 | private: |
DuyLionTran | 0:89e2c8a57572 | 142 | |
DuyLionTran | 0:89e2c8a57572 | 143 | void set_record_header(); |
DuyLionTran | 0:89e2c8a57572 | 144 | |
DuyLionTran | 0:89e2c8a57572 | 145 | void update_playload_length(){ |
DuyLionTran | 0:89e2c8a57572 | 146 | mRecordHeader.set_payload_length(1 + mLanguage.size() + mText.size()); |
DuyLionTran | 0:89e2c8a57572 | 147 | } |
DuyLionTran | 0:89e2c8a57572 | 148 | |
DuyLionTran | 0:89e2c8a57572 | 149 | /** |
DuyLionTran | 0:89e2c8a57572 | 150 | * encode the text encoding type and language size in a single byte |
DuyLionTran | 0:89e2c8a57572 | 151 | * @param enc encoding used by this record |
DuyLionTran | 0:89e2c8a57572 | 152 | * @param language language used by this record |
DuyLionTran | 0:89e2c8a57572 | 153 | * @return text encoding and language size in a single byte |
DuyLionTran | 0:89e2c8a57572 | 154 | */ |
DuyLionTran | 0:89e2c8a57572 | 155 | static uint8_t get_text_status(TextEncoding enc, |
DuyLionTran | 0:89e2c8a57572 | 156 | const std::string &language) { |
DuyLionTran | 0:89e2c8a57572 | 157 | uint8_t status = language.size(); |
DuyLionTran | 0:89e2c8a57572 | 158 | if (enc == UTF16) { |
DuyLionTran | 0:89e2c8a57572 | 159 | status &= 0x80; // set to 1 the bit 7 |
DuyLionTran | 0:89e2c8a57572 | 160 | } //if |
DuyLionTran | 0:89e2c8a57572 | 161 | return status; |
DuyLionTran | 0:89e2c8a57572 | 162 | } //getTextStatus |
DuyLionTran | 0:89e2c8a57572 | 163 | |
DuyLionTran | 0:89e2c8a57572 | 164 | /** |
DuyLionTran | 0:89e2c8a57572 | 165 | * extract the encoding information from a status byte |
DuyLionTran | 0:89e2c8a57572 | 166 | * @param textStatus status byte |
DuyLionTran | 0:89e2c8a57572 | 167 | * @return encoding used by this record |
DuyLionTran | 0:89e2c8a57572 | 168 | */ |
DuyLionTran | 0:89e2c8a57572 | 169 | static TextEncoding get_encoding(const uint8_t textStatus) { |
DuyLionTran | 0:89e2c8a57572 | 170 | if ((textStatus & 0x80) == 0) |
DuyLionTran | 0:89e2c8a57572 | 171 | return UTF8; |
DuyLionTran | 0:89e2c8a57572 | 172 | else |
DuyLionTran | 0:89e2c8a57572 | 173 | return UTF16; |
DuyLionTran | 0:89e2c8a57572 | 174 | } |
DuyLionTran | 0:89e2c8a57572 | 175 | |
DuyLionTran | 0:89e2c8a57572 | 176 | /** |
DuyLionTran | 0:89e2c8a57572 | 177 | * extract language string length from a status byte |
DuyLionTran | 0:89e2c8a57572 | 178 | * @param textStatus status byte |
DuyLionTran | 0:89e2c8a57572 | 179 | * @return number of bytes needed to store the language name used by this record |
DuyLionTran | 0:89e2c8a57572 | 180 | */ |
DuyLionTran | 0:89e2c8a57572 | 181 | static uint8_t get_language_length(const uint8_t textStatus) { |
DuyLionTran | 0:89e2c8a57572 | 182 | //take the fist 5 bits |
DuyLionTran | 0:89e2c8a57572 | 183 | return textStatus & 0x1F; |
DuyLionTran | 0:89e2c8a57572 | 184 | } |
DuyLionTran | 0:89e2c8a57572 | 185 | |
DuyLionTran | 0:89e2c8a57572 | 186 | const TextEncoding mEncode; |
DuyLionTran | 0:89e2c8a57572 | 187 | const std::string mLanguage; |
DuyLionTran | 0:89e2c8a57572 | 188 | std::string mText; |
DuyLionTran | 0:89e2c8a57572 | 189 | |
DuyLionTran | 0:89e2c8a57572 | 190 | const uint8_t mTextStatus; |
DuyLionTran | 0:89e2c8a57572 | 191 | |
DuyLionTran | 0:89e2c8a57572 | 192 | static const uint8_t NDEFTextIdCode; |
DuyLionTran | 0:89e2c8a57572 | 193 | |
DuyLionTran | 0:89e2c8a57572 | 194 | }; |
DuyLionTran | 0:89e2c8a57572 | 195 | |
DuyLionTran | 0:89e2c8a57572 | 196 | } /* namespace NDefLib */ |
DuyLionTran | 0:89e2c8a57572 | 197 | |
DuyLionTran | 0:89e2c8a57572 | 198 | #endif /* NDEFLIB_RECORDTYPE_RECORDTEXT_H_ */ |