TypeRegistry.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459
  1. #pragma once
  2. #include <Array.h>
  3. #include <DataValidator.h>
  4. #include <JSON.h>
  5. #include <Logging.h>
  6. #include <Trie.h>
  7. #include <typeinfo>
  8. class TypeRegistry;
  9. #define JSONObjectValidationBuilder \
  10. Framework::Validator::ObjectValidationBuilder< \
  11. Framework::Validator::DataValidator>
  12. template<typename T> class SimpleTypeFactory
  13. : public Framework::ReferenceCounter
  14. {
  15. public:
  16. SimpleTypeFactory()
  17. : ReferenceCounter() {};
  18. virtual T fromJson(Framework::JSON::JSONValue* zJson) const = 0;
  19. virtual Framework::JSON::JSONValue* toJson(T value) const = 0;
  20. virtual Framework::Validator::DataValidator* getValidator() const = 0;
  21. };
  22. /*
  23. * Used to convert an object of type T to a JSONValue and vice versa.
  24. * Can be registered at the TypeRegistry to be used by the JSON system
  25. */
  26. template<typename T> class ObjectTypeFactory : public SimpleTypeFactory<T*>
  27. {
  28. public:
  29. ObjectTypeFactory()
  30. : SimpleTypeFactory<T*>() {};
  31. T* fromJson(Framework::JSON::JSONValue* zJson) const final override
  32. {
  33. return fromJson(zJson->asObject());
  34. }
  35. Framework::JSON::JSONValue* toJson(T* value) const final override
  36. {
  37. return toJsonObject(value);
  38. }
  39. virtual Framework::Validator::DataValidator* getValidator() const override
  40. {
  41. return addToValidator(
  42. Framework::Validator::DataValidator::buildForObject())
  43. ->finishObject();
  44. };
  45. virtual JSONObjectValidationBuilder* addToValidator(
  46. JSONObjectValidationBuilder* builder) const
  47. = 0;
  48. protected:
  49. virtual T* fromJson(Framework::JSON::JSONObject* zJson) const = 0;
  50. virtual Framework::JSON::JSONObject* toJsonObject(T* zObject) const = 0;
  51. };
  52. /*
  53. * Used to convert an object of type S witch inherits from type T to a
  54. * JSONValue and vice versa. Can be registered at the TypeRegistry to be
  55. * used by the JSON
  56. */
  57. template<typename T,
  58. typename S,
  59. typename = std::enable_if<std::is_base_of<T, S>::value>>
  60. class SubTypeFactory : public ObjectTypeFactory<S>
  61. {
  62. public:
  63. SubTypeFactory()
  64. : ObjectTypeFactory<S>() {};
  65. virtual Framework::Validator::DataValidator*
  66. getValidator() const final override
  67. {
  68. Framework::Text referenceId = "_type_";
  69. referenceId.append() << typeid(T).name() << "_" << getTypeToken();
  70. return this
  71. ->addToValidator(
  72. Framework::Validator::DataValidator::buildForObject()
  73. ->withRequiredString("type")
  74. ->withExactMatch(getTypeToken())
  75. ->finishString()
  76. ->setReferenceId(referenceId))
  77. ->finishObject();
  78. };
  79. virtual const char* getTypeToken() const = 0;
  80. virtual const char* getTypeName() const
  81. {
  82. return typeid(S).name();
  83. }
  84. };
  85. template<typename T> class SubTypeFactoryRef
  86. : public Framework::ReferenceCounter
  87. {
  88. private:
  89. std::function<const char*()> typetokenFunc;
  90. std::function<T*(Framework::JSON::JSONValue*)> fromJsonFunc;
  91. std::function<Framework::JSON::JSONValue*(T*)> toJsonFunc;
  92. std::function<Framework::Validator::DataValidator*()> getValidatorFunc;
  93. Framework::ReferenceCounter* factory;
  94. public:
  95. SubTypeFactoryRef(std::function<const char*()> typetokenFunc,
  96. std::function<T*(Framework::JSON::JSONValue*)> fromJsonFunc,
  97. std::function<Framework::JSON::JSONValue*(T*)> toJsonFunc,
  98. std::function<Framework::Validator::DataValidator*()> getValidatorFunc,
  99. Framework::ReferenceCounter* factory)
  100. : ReferenceCounter(),
  101. typetokenFunc(typetokenFunc),
  102. fromJsonFunc(fromJsonFunc),
  103. toJsonFunc(toJsonFunc),
  104. getValidatorFunc(getValidatorFunc),
  105. factory(factory)
  106. {}
  107. ~SubTypeFactoryRef()
  108. {
  109. factory->release();
  110. }
  111. T* fromJson(Framework::JSON::JSONValue* zJson) const
  112. {
  113. return fromJsonFunc(zJson);
  114. }
  115. Framework::JSON::JSONValue* toJson(T* zObject) const
  116. {
  117. return toJsonFunc(zObject);
  118. }
  119. Framework::Validator::DataValidator* getValidator() const
  120. {
  121. return getValidatorFunc();
  122. }
  123. const char* getTypeToken() const
  124. {
  125. return typetokenFunc();
  126. }
  127. };
  128. template<typename T> class PolymorphTypeFactory : public ObjectTypeFactory<T>
  129. {
  130. private:
  131. Framework::RCArray<SubTypeFactoryRef<T>> factories;
  132. Framework::RCArray<Framework::Text> typeNames;
  133. static thread_local bool insideGetValidator;
  134. public:
  135. PolymorphTypeFactory()
  136. : ObjectTypeFactory<T>()
  137. {}
  138. T* fromJson(Framework::JSON::JSONObject* zJson) const override
  139. {
  140. for (SubTypeFactoryRef<T>* factory : factories)
  141. {
  142. if (zJson->zValue("type")->asString()->getString().istGleich(
  143. factory->getTypeToken()))
  144. {
  145. return factory->fromJson(zJson);
  146. }
  147. }
  148. Framework::Logging::error()
  149. << "No Sub Type Factory for typetoken "
  150. << zJson->zValue("type")->asString()->getString() << " of type "
  151. << typeid(T).name() << " was found.";
  152. return 0;
  153. }
  154. Framework::JSON::JSONObject* toJsonObject(T* zObject) const override
  155. {
  156. auto name = typeNames.begin();
  157. for (SubTypeFactoryRef<T>* factory : factories)
  158. {
  159. if (name->istGleich(typeid(*zObject).name()))
  160. {
  161. Framework::JSON::JSONObject* result
  162. = factory->toJson(zObject)->asObject();
  163. result->addValue("type",
  164. new Framework::JSON::JSONString(factory->getTypeToken()));
  165. return result;
  166. }
  167. name++;
  168. }
  169. Framework::Logging::error()
  170. << "No Sub Type Factory for subtype " << typeid(*zObject).name()
  171. << " of type " << typeid(T).name() << " was found.";
  172. return new Framework::JSON::JSONObject();
  173. }
  174. JSONObjectValidationBuilder* addToValidator(
  175. JSONObjectValidationBuilder* builder) const override
  176. {
  177. Framework::Logging::error()
  178. << "Can not add polymorph json validator to an object "
  179. "validation builder";
  180. throw "Can not add polymorph json "
  181. "validator to an object "
  182. "validation builder";
  183. }
  184. Framework::Validator::DataValidator* getValidator() const override
  185. {
  186. Framework::Validator::DataValidator* result;
  187. if (!insideGetValidator)
  188. {
  189. insideGetValidator = true;
  190. auto validator
  191. = Framework::Validator::DataValidator::buildForOneOf()
  192. ->typeSpecifiedByAttribute("type");
  193. for (SubTypeFactoryRef<T>* factory : factories)
  194. {
  195. validator = validator->addAcceptedType(factory->getValidator());
  196. }
  197. result = validator->finishOneOf();
  198. insideGetValidator = false;
  199. }
  200. else
  201. {
  202. auto validator
  203. = Framework::Validator::DataValidator::buildForOneOf()
  204. ->typeSpecifiedByAttribute("type");
  205. for (SubTypeFactoryRef<T>* factory : factories)
  206. {
  207. validator = validator->addAcceptedType(
  208. Framework::Validator::DataValidator::buildForReference(
  209. ((Framework::Text("_type_") += typeid(T).name()) += "_")
  210. += factory->getTypeToken()));
  211. }
  212. result = validator->finishOneOf();
  213. }
  214. return result;
  215. }
  216. template<typename S,
  217. typename = std::enable_if<std::is_base_of<T, S>::value>>
  218. void addFactory(SubTypeFactory<T, S>* factory)
  219. {
  220. factories.add(new SubTypeFactoryRef<T>(
  221. [factory]() { return factory->getTypeToken(); },
  222. [factory](Framework::JSON::JSONValue* zJson) {
  223. S* value = factory->fromJson(zJson);
  224. if (value)
  225. {
  226. return dynamic_cast<T*>(value);
  227. }
  228. return (T*)0;
  229. },
  230. [factory](T* zObject) {
  231. return factory->toJson(dynamic_cast<S*>(zObject));
  232. },
  233. [factory]() { return factory->getValidator(); },
  234. dynamic_cast<Framework::ReferenceCounter*>(factory)));
  235. typeNames.add(new Framework::Text(factory->getTypeName()));
  236. }
  237. };
  238. template<typename T>
  239. thread_local bool PolymorphTypeFactory<T>::insideGetValidator = false;
  240. class TypeFatoryRef : public Framework::ReferenceCounter
  241. {
  242. private:
  243. std::function<void*(Framework::JSON::JSONValue*)> fromJsonFunc;
  244. std::function<Framework::JSON::JSONValue*(void*)> toJsonFunc;
  245. std::function<Framework::Validator::DataValidator*()> getValidatorFunc;
  246. Framework::ReferenceCounter* factory;
  247. public:
  248. TypeFatoryRef(
  249. std::function<void*(Framework::JSON::JSONValue*)> fromJsonFunc,
  250. std::function<Framework::JSON::JSONValue*(void*)> toJsonFunc,
  251. std::function<Framework::Validator::DataValidator*()> getValidatorFunc,
  252. Framework::ReferenceCounter* factory)
  253. : ReferenceCounter(),
  254. fromJsonFunc(fromJsonFunc),
  255. toJsonFunc(toJsonFunc),
  256. getValidatorFunc(getValidatorFunc),
  257. factory(factory)
  258. {}
  259. ~TypeFatoryRef()
  260. {
  261. factory->release();
  262. }
  263. void* fromJson(Framework::JSON::JSONValue* zJson) const
  264. {
  265. return fromJsonFunc(zJson);
  266. }
  267. Framework::JSON::JSONValue* toJson(void* zObject) const
  268. {
  269. return toJsonFunc(zObject);
  270. }
  271. Framework::Validator::DataValidator* getValidator() const
  272. {
  273. return getValidatorFunc();
  274. }
  275. Framework::ReferenceCounter* zFactory() const
  276. {
  277. return factory;
  278. }
  279. };
  280. class TypeRegistry : public Framework::ReferenceCounter
  281. {
  282. private:
  283. Framework::RCTrie<TypeFatoryRef> parsableTypes;
  284. Framework::RCArray<Framework::Text> parsableTypeNames;
  285. public:
  286. TypeRegistry();
  287. template<typename T,
  288. typename S,
  289. typename = std::enable_if<std::is_base_of<T, S>::value>>
  290. void registerSubType(SubTypeFactory<T, S>* factory)
  291. {
  292. Framework::Text typeId = typeid(T).name();
  293. TypeFatoryRef* typeFactoryRef
  294. = parsableTypes.z(typeId, typeId.getLength());
  295. if (!typeFactoryRef)
  296. {
  297. PolymorphTypeFactory<T>* polymorphFactory
  298. = new PolymorphTypeFactory<T>();
  299. registerType(polymorphFactory);
  300. typeFactoryRef = parsableTypes.z(typeId, typeId.getLength());
  301. parsableTypeNames.add(new Framework::Text(typeId));
  302. }
  303. PolymorphTypeFactory<T>* polymorphFactory
  304. = dynamic_cast<PolymorphTypeFactory<T>*>(
  305. typeFactoryRef->zFactory());
  306. if (!polymorphFactory)
  307. {
  308. Framework::Logging::error()
  309. << Framework::Text("Type not registered as Polymorphic type: ")
  310. + typeId;
  311. throw Framework::Text("Type not registered as Polymorphic type: ")
  312. + typeId;
  313. }
  314. polymorphFactory->addFactory<S>(factory);
  315. Framework::Text typeIdS = typeid(S).name();
  316. parsableTypeNames.add(new Framework::Text(typeIdS));
  317. registerType(factory);
  318. }
  319. template<typename T> void registerType(ObjectTypeFactory<T>* factory)
  320. {
  321. registerType(typeid(T).name(), factory);
  322. }
  323. template<typename T>
  324. void registerType(Framework::Text typeId, SimpleTypeFactory<T>* factory)
  325. {
  326. TypeFatoryRef* typeFactoryRef
  327. = parsableTypes.z(typeId, typeId.getLength());
  328. if (typeFactoryRef)
  329. {
  330. Framework::Logging::error()
  331. << Framework::Text("Type already registered: ") + typeId;
  332. throw Framework::Text("Type already registered: ") + typeId;
  333. }
  334. typeFactoryRef = new TypeFatoryRef(
  335. [factory](Framework::JSON::JSONValue* zJson) {
  336. return (void*)factory->fromJson(zJson);
  337. },
  338. [factory](void* zObject) { return factory->toJson((T)zObject); },
  339. [factory]() { return factory->getValidator(); },
  340. factory);
  341. parsableTypes.set(typeId, typeId.getLength(), typeFactoryRef);
  342. parsableTypeNames.add(new Framework::Text(typeId));
  343. }
  344. template<typename T>
  345. T fromJson(Framework::Text typeId, Framework::JSON::JSONValue* zJson) const
  346. {
  347. TypeFatoryRef* typeFactoryRef
  348. = parsableTypes.z(typeId, typeId.getLength());
  349. if (!typeFactoryRef)
  350. {
  351. Framework::Logging::error()
  352. << Framework::Text("Type not registered: ") + typeId;
  353. throw Framework::Text("Type not registered: ") + typeId;
  354. }
  355. return (T)(typeFactoryRef->fromJson(zJson));
  356. }
  357. template<typename T> T* fromJson(Framework::JSON::JSONValue* zJson) const
  358. {
  359. return fromJson<T*>(typeid(T).name(), zJson);
  360. }
  361. template<typename T> Framework::JSON::JSONValue* toJson(T* zObject) const
  362. {
  363. return toJson<T*>(typeid(T).name(), zObject);
  364. }
  365. template<typename T> Framework::JSON::JSONValue* toJson(
  366. Framework::Text typeId, const T zObject) const
  367. {
  368. TypeFatoryRef* typeFactoryRef
  369. = parsableTypes.z(typeId, typeId.getLength());
  370. if (!typeFactoryRef)
  371. {
  372. Framework::Logging::error()
  373. << Framework::Text("Type not registered: ") + typeId;
  374. throw Framework::Text("Type not registered: ") + typeId;
  375. }
  376. return typeFactoryRef->toJson((void*)zObject);
  377. }
  378. template<typename T>
  379. Framework::Validator::DataValidator* getValidator() const
  380. {
  381. return getValidator<T>(typeid(T).name());
  382. }
  383. template<typename T> Framework::Validator::DataValidator* getValidator(
  384. Framework::Text typeId) const
  385. {
  386. TypeFatoryRef* typeFactoryRef
  387. = parsableTypes.z(typeId, typeId.getLength());
  388. if (!typeFactoryRef)
  389. {
  390. Framework::Logging::error()
  391. << Framework::Text("Type not registered: ") + typeId;
  392. throw Framework::Text("Type not registered: ") + typeId;
  393. }
  394. return typeFactoryRef->getValidator();
  395. }
  396. template<typename T> Framework::JSON::JSONValue* getValidParts(
  397. Framework::JSON::JSONValue* zJson) const
  398. {
  399. Framework::RCArray<Framework::Validator::ValidationResult> invalidParts;
  400. Framework::Validator::DataValidator* validator = getValidator<T>();
  401. Framework::JSON::JSONValue* result
  402. = validator->getValidParts(zJson, &invalidParts);
  403. for (Framework::Validator::ValidationResult* invalidPart : invalidParts)
  404. {
  405. Framework::Logging::error() << invalidPart->getInvalidInfo();
  406. }
  407. return result;
  408. }
  409. void writeSyntaxInfo(Framework::Text folderPath) const;
  410. };