author | František Kučera <franta-hg@frantovo.cz> |
Fri, 22 Apr 2022 23:47:08 +0200 | |
branch | v_0 |
changeset 57 | 08c392fc66e4 |
parent 41 | 744b61559eb2 |
permissions | -rw-r--r-- |
29
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
1 |
/** |
30
3f18cb7a6963
license of protocol, reader and writer: GNU LGPLv3+ or GNU GPLv2+
František Kučera <franta-hg@frantovo.cz>
parents:
29
diff
changeset
|
2 |
* Relational pipes (library) |
29
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
3 |
* Copyright © 2018 František Kučera (Frantovo.cz, GlobalCode.info) |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
4 |
* |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
5 |
* This program is free software: you can redistribute it and/or modify |
30
3f18cb7a6963
license of protocol, reader and writer: GNU LGPLv3+ or GNU GPLv2+
František Kučera <franta-hg@frantovo.cz>
parents:
29
diff
changeset
|
6 |
* it under the terms of the: |
3f18cb7a6963
license of protocol, reader and writer: GNU LGPLv3+ or GNU GPLv2+
František Kučera <franta-hg@frantovo.cz>
parents:
29
diff
changeset
|
7 |
* - GNU Lesser General Public License as published by the Free Software Foundation; |
41
744b61559eb2
fix license version: GNU LGPLv3 or GPLv2
František Kučera <franta-hg@frantovo.cz>
parents:
30
diff
changeset
|
8 |
* version 3 of the License or (at your option) |
30
3f18cb7a6963
license of protocol, reader and writer: GNU LGPLv3+ or GNU GPLv2+
František Kučera <franta-hg@frantovo.cz>
parents:
29
diff
changeset
|
9 |
* - GNU General Public License as published by the Free Software Foundation; |
41
744b61559eb2
fix license version: GNU LGPLv3 or GPLv2
František Kučera <franta-hg@frantovo.cz>
parents:
30
diff
changeset
|
10 |
* version 2 of the License. |
29
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
11 |
* |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
12 |
* This program is distributed in the hope that it will be useful, |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
13 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
14 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
15 |
* GNU General Public License for more details. |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
16 |
* |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
18 |
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
142bdbba520f
license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents:
25
diff
changeset
|
19 |
*/ |
1 | 20 |
#pragma once |
21 |
||
22 |
#include <string> |
|
25
135ef93a4ac2
imports, namespaces
František Kučera <franta-hg@frantovo.cz>
parents:
20
diff
changeset
|
23 |
#include "../include/relpipe/writer/TypeId.h" |
20
bef6648e79b1
relpipe-lib-writer: move public header files to: include/relpipe/writer/
František Kučera <franta-hg@frantovo.cz>
parents:
19
diff
changeset
|
24 |
#include "../include/relpipe/writer/typedefs.h" |
1 | 25 |
|
26 |
namespace relpipe { |
|
27 |
namespace writer { |
|
28 |
||
29 |
/** |
|
30 |
* This class contains common features that are independent from particular data type (generic/template type) |
|
31 |
*/ |
|
32 |
class DataTypeWriterBase { |
|
33 |
private: |
|
15
8fd6c4d44071
use more TypeId enum
František Kučera <franta-hg@frantovo.cz>
parents:
9
diff
changeset
|
34 |
const TypeId typeId; |
1 | 35 |
const string_t typeCode; |
36 |
public: |
|
37 |
||
15
8fd6c4d44071
use more TypeId enum
František Kučera <franta-hg@frantovo.cz>
parents:
9
diff
changeset
|
38 |
DataTypeWriterBase(const TypeId typeId, const string_t typeCode) : |
1 | 39 |
typeId(typeId), typeCode(typeCode) { |
40 |
} |
|
41 |
||
42 |
virtual ~DataTypeWriterBase() { |
|
43 |
}; |
|
44 |
||
4
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
45 |
/** |
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
46 |
* @param output output stream, should be at position where the value is to be written; the stream will not be closed not flushed after writing |
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
47 |
* @param stringValue write value as given data type (e.g. integer or boolean); stringValue parameter contains given value in string representation of given data type |
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
48 |
* E.g. integer 123 is passed as a character string "123" |
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
49 |
* boolean true is passed as a character string "true". |
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
50 |
* See Relational pipes format specification for details. |
e6db28447957
documentation for readString() and writeString() methods
František Kučera <franta-hg@frantovo.cz>
parents:
3
diff
changeset
|
51 |
*/ |
1 | 52 |
virtual void writeString(std::ostream& output, const string_t &stringValue) = 0; |
53 |
||
54 |
/** |
|
16
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
55 |
* @param output output stream, should be at position where the value is to be written; the stream will not be closed not flushed after writing |
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
56 |
* @param value raw pointer to the value, must exactly match data type of this writer |
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
57 |
* @param type used as a safety mechanism to avoid wrong pointer interpretation; |
18
90efe2db1ca8
documentation for RelationalWriter and DataTypeWriterBase
František Kučera <franta-hg@frantovo.cz>
parents:
16
diff
changeset
|
58 |
* should be called in this way: writeRaw(output, &value, typeid(value)); |
16
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
59 |
* if the type does not match, the RelpipeWriterException is thrown |
19
98b901d7bb95
ASan: add AddressSanitizer g++ option: -fsanitize=address
František Kučera <franta-hg@frantovo.cz>
parents:
18
diff
changeset
|
60 |
* |
98b901d7bb95
ASan: add AddressSanitizer g++ option: -fsanitize=address
František Kučera <franta-hg@frantovo.cz>
parents:
18
diff
changeset
|
61 |
* TODO: typeid() / type_info seems working but consider also sizeof() / size_t and teplates |
16
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
62 |
*/ |
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
63 |
virtual void writeRaw(std::ostream& output, const void * value, const std::type_info& type) = 0; |
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
64 |
|
3613617d3076
writeAttribute() with raw pointer and type_info
František Kučera <franta-hg@frantovo.cz>
parents:
15
diff
changeset
|
65 |
/** |
1 | 66 |
* @param dataType data type code as defined in DDP L0 |
67 |
* @return whether this class supports conversions of this type |
|
68 |
*/ |
|
15
8fd6c4d44071
use more TypeId enum
František Kučera <franta-hg@frantovo.cz>
parents:
9
diff
changeset
|
69 |
virtual bool supports(const TypeId &dataType) { |
9
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
70 |
return dataType == typeId; |
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
71 |
} |
1 | 72 |
|
73 |
/** |
|
74 |
* @param dataType data type name as defined in DDP L0 |
|
75 |
* @return whether this class supports conversions of this type |
|
76 |
*/ |
|
9
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
77 |
virtual bool supports(const string_t &dataType) { |
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
78 |
return dataType == typeCode; |
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
79 |
} |
1 | 80 |
|
15
8fd6c4d44071
use more TypeId enum
František Kučera <franta-hg@frantovo.cz>
parents:
9
diff
changeset
|
81 |
TypeId getTypeId() { |
9
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
82 |
return typeId; |
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
83 |
} |
1 | 84 |
|
9
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
85 |
string_t getTypeCode() { |
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
86 |
return typeCode; |
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
87 |
} |
1 | 88 |
}; |
89 |
||
90 |
} |
|
9
0a40752e401d
shared library with pure abstract class (interface)
František Kučera <franta-hg@frantovo.cz>
parents:
5
diff
changeset
|
91 |
} |