From 937e67ff5ae9e770367bfee3100154b6a6957ce7 Mon Sep 17 00:00:00 2001 From: Claudius Holeksa Date: Sat, 29 Apr 2023 18:03:24 +0200 Subject: Added codec and ammended async build --- default.nix | 7 + forstio/async/SConscript | 30 +- forstio/codec/.nix/derivation.nix | 31 +++ forstio/codec/SConscript | 38 +++ forstio/codec/SConstruct | 66 +++++ forstio/codec/message.h | 564 ++++++++++++++++++++++++++++++++++++++ forstio/codec/message_container.h | 246 +++++++++++++++++ forstio/codec/schema.h | 77 ++++++ forstio/core/SConscript | 2 +- 9 files changed, 1048 insertions(+), 13 deletions(-) create mode 100644 forstio/codec/.nix/derivation.nix create mode 100644 forstio/codec/SConscript create mode 100644 forstio/codec/SConstruct create mode 100644 forstio/codec/message.h create mode 100644 forstio/codec/message_container.h create mode 100644 forstio/codec/schema.h diff --git a/default.nix b/default.nix index d69b0e0..8311373 100644 --- a/default.nix +++ b/default.nix @@ -17,5 +17,12 @@ in rec { clang = pkgs.clang_15; clang-tools = pkgs.clang-tools_15; }; + + codec = pkgs.callPackage forstio/codec/.nix/derivation.nix { + inherit version; + inherit forstio; + clang = pkgs.clang_15; + clang-tools = pkgs.clang-tools_15; + }; }; } diff --git a/forstio/async/SConscript b/forstio/async/SConscript index 0b1e7dd..69f8950 100644 --- a/forstio/async/SConscript +++ b/forstio/async/SConscript @@ -9,24 +9,30 @@ Import('env') dir_path = Dir('.').abspath -env.sources += sorted(glob.glob(dir_path + "/*.cpp")) -env.headers += sorted(glob.glob(dir_path + "/*.h")) - # Environment for base library -base_lib_env = env.Clone(); +async_env = env.Clone(); + +async_env.sources = sorted(glob.glob(dir_path + "/*.cpp")) +async_env.headers = sorted(glob.glob(dir_path + "/*.h")) + +env.sources += async_env.sources; +env.headers += async_env.headers; ## Shared lib objects_shared = [] -base_lib_env.add_source_files(objects_shared, env.sources, shared=True); -env.library_shared = base_lib_env.SharedLibrary('#build/forstio-async', [objects_shared]); +async_env.add_source_files(objects_shared, async_env.sources, shared=True); +async_env.library_shared = async_env.SharedLibrary('#build/forstio-async', [objects_shared]); ## Static lib objects_static = [] -base_lib_env.add_source_files(objects_static, env.sources, shared=False); -env.library_static = base_lib_env.StaticLibrary('#build/forstio-async', [objects_static]); - -# Export to other libs -Export('base_lib_env') +async_env.add_source_files(objects_static, async_env.sources, shared=False); +async_env.library_static = async_env.StaticLibrary('#build/forstio-async', [objects_static]); # Set Alias -env.Alias('library', [env.library_shared, env.library_static]); +env.Alias('library_async', [async_env.library_shared, async_env.library_static]); + +env.targets += ['library_async']; + +# Install +env.Install('$prefix/lib/', [async_env.library_shared, async_env.library_static]); +env.Install('$prefix/include/forstio/async/', [async_env.headers]); diff --git a/forstio/codec/.nix/derivation.nix b/forstio/codec/.nix/derivation.nix new file mode 100644 index 0000000..c9fac2e --- /dev/null +++ b/forstio/codec/.nix/derivation.nix @@ -0,0 +1,31 @@ +{ lib +, stdenvNoCC +, scons +, clang +, clang-tools +, version +, forstio +}: + +let + +in stdenvNoCC.mkDerivation { + pname = "forstio-codec"; + inherit version; + + src = ./..; + + enableParallelBuilding = true; + + buildInputs = [ + forstio.core + ]; + + nativeBuildInputs = [ + scons + clang + clang-tools + ]; + + outputs = ["out" "dev"]; +} diff --git a/forstio/codec/SConscript b/forstio/codec/SConscript new file mode 100644 index 0000000..c038d42 --- /dev/null +++ b/forstio/codec/SConscript @@ -0,0 +1,38 @@ +#!/bin/false + +import os +import os.path +import glob + + +Import('env') + +dir_path = Dir('.').abspath + +# Environment for base library +codec_env = env.Clone(); + +codec_env.sources = sorted(glob.glob(dir_path + "/*.cpp")) +codec_env.headers = sorted(glob.glob(dir_path + "/*.h")) + +env.sources += codec_env.sources; +env.headers += codec_env.headers; + +## Shared lib +objects_shared = [] +codec_env.add_source_files(objects_shared, codec_env.sources, shared=True); +codec_env.library_shared = codec_env.SharedLibrary('#build/forstio-codec', [objects_shared]); + +## Static lib +objects_static = [] +codec_env.add_source_files(objects_static, codec_env.sources, shared=False); +codec_env.library_static = codec_env.StaticLibrary('#build/forstio-codec', [objects_static]); + +# Set Alias +env.Alias('library_codec', [codec_env.library_shared, codec_env.library_static]); + +env.targets += ['library_codec']; + +# Install +env.Install('$prefix/lib/', [codec_env.library_shared, codec_env.library_static]); +env.Install('$prefix/include/forstio/codec/', [codec_env.headers]); diff --git a/forstio/codec/SConstruct b/forstio/codec/SConstruct new file mode 100644 index 0000000..0d7b7c6 --- /dev/null +++ b/forstio/codec/SConstruct @@ -0,0 +1,66 @@ +#!/usr/bin/env python3 + +import sys +import os +import os.path +import glob +import re + + +if sys.version_info < (3,): + def isbasestring(s): + return isinstance(s,basestring) +else: + def isbasestring(s): + return isinstance(s, (str,bytes)) + +def add_kel_source_files(self, sources, filetype, lib_env=None, shared=False, target_post=""): + + if isbasestring(filetype): + dir_path = self.Dir('.').abspath + filetype = sorted(glob.glob(dir_path+"/"+filetype)) + + for path in filetype: + target_name = re.sub( r'(.*?)(\.cpp|\.c\+\+)', r'\1' + target_post, path ) + if shared: + target_name+='.os' + sources.append( self.SharedObject( target=target_name, source=path ) ) + else: + target_name+='.o' + sources.append( self.StaticObject( target=target_name, source=path ) ) + pass + +def isAbsolutePath(key, dirname, env): + assert os.path.isabs(dirname), "%r must have absolute path syntax" % (key,) + +env_vars = Variables( + args=ARGUMENTS +) + +env_vars.Add('prefix', + help='Installation target location of build results and headers', + default='/usr/local/', + validator=isAbsolutePath +) + +env=Environment(ENV=os.environ, variables=env_vars, CPPPATH=[], + CPPDEFINES=['SAW_UNIX'], + CXXFLAGS=['-std=c++20','-g','-Wall','-Wextra'], + LIBS=['forstio-core']) +env.__class__.add_source_files = add_kel_source_files +env.Tool('compilation_db'); +env.cdb = env.CompilationDatabase('compile_commands.json'); + +env.objects = []; +env.sources = []; +env.headers = []; +env.targets = []; + +Export('env') +SConscript('SConscript') + +env.Alias('cdb', env.cdb); +env.Alias('all', [env.targets]); +env.Default('all'); + +env.Alias('install', '$prefix') diff --git a/forstio/codec/message.h b/forstio/codec/message.h new file mode 100644 index 0000000..f0cadfd --- /dev/null +++ b/forstio/codec/message.h @@ -0,0 +1,564 @@ +#pragma once + +#include +#include +#include +#include +#include + +#include + +#include +#include + +#include "message_container.h" +#include "schema.h" + +namespace saw { +class message_base { +protected: + bool set_explicitly_ = false; + +public: + template T &as() { + static_assert(std::is_base_of()); + return dynamic_cast(*this); + } + + template const T &as() const { + static_assert(std::is_base_of()); + return dynamic_cast(*this); + } +}; +/* + * Representing all message types + * Description which type to use happens through the use of the schema classes + * in schema.h The message classes are wrapper classes which store the data + * according to the specified container class. + * + * The reader and builder classe exist to create some clarity while implementing + * parsers. Also minor guarantess are provided if the message is used as a + * template parameter. + */ + +/* + * Struct Message + */ +template +class message...>, Container> final + : public message_base { +private: + using SchemaType = schema::Struct...>; + using MessageType = message; + Container container_; + + static_assert(std::is_same_v, + "Container should have same the schema as Message"); + + friend class builder; + friend class reader; + +public: + class reader; + class builder { + private: + MessageType &message_; + + public: + builder(MessageType &msg) : message_{msg} {} + + reader as_reader() { return reader{message_}; } + + /* + * Initialize a member by index + */ + template + typename std::enable_if< + !schema_is_array< + typename message_parameter_pack_type::Type>::Value, + typename Container::template ElementType::builder>::type + init() { + return typename Container::template ElementType::builder{ + message_.container_.template get()}; + } + + /* + * Initialize a member by their name + * This is the preferred method for schema::Struct messages + */ + template + typename std::enable_if< + !schema_is_array::Value, + V...>::Type>::Value, + typename Container::template ElementType< + message_parameter_key_pack_index::Value>:: + builder>::type + init() { + constexpr size_t i = + message_parameter_key_pack_index::Value; + + return init(); + } + + template + typename std::enable_if< + schema_is_array< + typename message_parameter_pack_type::Type>::Value, + typename Container::template ElementType::builder>::type + init(size_t size = 0) { + auto array_builder = + typename Container::template ElementType::builder{ + message_.container_.template get(), size}; + return array_builder; + } + + /* + * Version for array schema type + */ + template + typename std::enable_if< + schema_is_array::Value, + V...>::Type>::Value, + typename Container::template ElementType< + message_parameter_key_pack_index::Value>:: + builder>::type + init(size_t size) { + constexpr size_t i = + message_parameter_key_pack_index::Value; + + return init(size); + } + }; + + class reader { + private: + MessageType &message_; + + public: + reader(MessageType &msg) : message_{msg} {} + + builder as_builder() { return builder{message_}; } + + /* + * Get member by index + */ + template + typename Container::template ElementType::reader get() { + return typename Container::template ElementType::reader{ + message_.container_.template get()}; + } + + /* + * Get member by name + * This is the preferred method for schema::Struct messages + */ + template + typename Container::template ElementType< + message_parameter_key_pack_index::Value>::reader + get() { + // The index of the first match + constexpr size_t i = + message_parameter_key_pack_index::Value; + + return get(); + } + }; + + builder build() { return builder{*this}; } + + reader read() { return reader{*this}; } +}; + +/* + * Union message class. Wrapper object + */ +template +class message...>, Container> final + : public message_base { +private: + using SchemaType = schema::Union...>; + using MessageType = message; + + Container container_; + + static_assert(std::is_same_v, + "Container should have same the schema as Message"); + + friend class builder; + friend class reader; + +public: + class reader; + class builder { + private: + MessageType &message_; + + public: + builder(MessageType &msg) : message_{msg} {} + + reader as_reader() { return reader{message_}; } + + template + typename std::enable_if< + !schema_is_array< + typename message_parameter_pack_type::Type>::Value, + typename Container::template ElementType::builder>::type + + init() { + return typename Container::template ElementType::builder{ + message_.container_.template get()}; + } + + template + typename std::enable_if< + !schema_is_array::Value, + V...>::Type>::Value, + typename Container::template ElementType< + message_parameter_key_pack_index::Value>:: + builder>::type + init() { + constexpr size_t i = + message_parameter_key_pack_index::Value; + + return init(); + } + + /* + * If Schema is Array + */ + template + typename std::enable_if< + schema_is_array< + typename message_parameter_pack_type::Type>::Value, + typename Container::template ElementType::builder>::type + init(size_t size = 0) { + return typename Container::template ElementType::builder{ + message_.container_.template get(), size}; + } + + template + typename std::enable_if< + schema_is_array::Value, + V...>::Type>::Value, + typename Container::template ElementType< + message_parameter_key_pack_index::Value>:: + builder>::type + init(size_t size) { + constexpr size_t i = + message_parameter_key_pack_index::Value; + + return init(size); + } + }; + + class reader { + private: + MessageType &message_; + + public: + reader(MessageType &msg) : message_{msg} {} + + builder as_builder() { return builder{message_}; } + + template + typename Container::template ElementType::reader get() { + return typename Container::template ElementType::reader{ + message_.container_.template get()}; + } + + template + typename Container::template ElementType< + message_parameter_key_pack_index::Value>::reader + get() { + // The index of the first match + constexpr size_t i = + message_parameter_key_pack_index::Value; + + return get(); + } + + template + static constexpr size_t to_index() noexcept { + return message_parameter_key_pack_index::Value; + } + + size_t index() const noexcept { return message_.container_.index(); } + + template bool has_alternative() const { + return index() == to_index(); + } + }; +}; + +/* + * Array message class. Wrapper around an array schema element + */ +template +class message, Container> final : public message_base { +private: + using SchemaType = schema::Array; + using MessageType = message; + + Container container_; + + static_assert(std::is_same_v, + "Container should have same Schema as Message"); + + friend class builder; + friend class reader; + +public: + class reader; + class builder { + private: + MessageType &message_; + + public: + builder(MessageType &msg, size_t size) : message_{msg} { + if (size > 0) { + message_.container_.resize(size); + } + } + + reader as_reader() { return reader{message_}; } + + typename Container::ElementType::builder init(size_t i) { + return typename Container::ElementType::builder{ + message_.container_.get(i)}; + } + + size_t size() const { return message_.container_.size(); } + + void resize(size_t size) { message_.container_.resize(size); } + }; + + class reader { + private: + MessageType &message_; + + public: + reader(MessageType &msg) : message_{msg} {} + + builder as_builder() { return builder{message_, 0}; } + + typename Container::ElementType::reader get(size_t i) { + return typename Container::ElementType::reader{ + message_.container_.get(i)}; + } + + size_t size() const { return message_.container_.size(); } + }; +}; + +/* + * Tuple message class. Wrapper around a tuple schema + */ +template +class message, Container> final : public message_base { +private: + using SchemaType = schema::Tuple; + using MessageType = message; + + Container container_; + + static_assert(std::is_same_v, + "Container should have same the schema as Message"); + + friend class builder; + friend class reader; + +public: + class reader; + class builder { + MessageType &message_; + + public: + builder(MessageType &msg) : message_{msg} {} + + reader as_reader() { return reader{message_}; } + + template + typename std::enable_if< + !schema_is_array< + typename message_parameter_pack_type::Type>::Value, + typename Container::template ElementType::builder>::type + init() { + return typename Container::template ElementType::builder{ + message_.container_.template get()}; + } + + template + typename std::enable_if< + schema_is_array< + typename message_parameter_pack_type::Type>::Value, + typename Container::template ElementType::builder>::type + init(size_t size = 0) { + return typename Container::template ElementType::builder{ + message_.container_.template get(), size}; + } + }; + class reader { + private: + MessageType &message_; + + public: + reader(MessageType &msg) : message_{msg} {} + + builder as_builder() { return builder{message_}; } + + template + typename Container::template ElementType::reader get() { + return typename Container::template ElementType::reader{ + message_.container_.template get()}; + } + }; +}; + +/* + * Primitive type (float, double, uint8_t, uint16_t, uint32_t, uint64_t, int8_t, + * int16_t, int32_t, int64_t) message class + */ +template +class message, Container> final : public message_base { +private: + using SchemaType = schema::Primitive; + using MessageType = message; + + Container container_; + + static_assert(std::is_same_v, + "Container should have same the schema as Message"); + + friend class builder; + friend class reader; + +public: + class reader; + class builder { + private: + MessageType &message_; + + public: + builder(MessageType &msg) : message_{msg} {} + + reader as_reader() { return reader{message_}; } + + void set(const typename Container::ValueType &value) { + message_.container_.set(value); + } + }; + + class reader { + private: + MessageType &message_; + + public: + reader(message &msg) : message_{msg} {} + + builder as_builder() { return builder{message_}; } + + const typename Container::ValueType &get() const { + return message_.container_.get(); + } + }; +}; + +template +class message final : public message_base { +private: + using SchemaType = schema::String; + using MessageType = message; + + Container container_; + + static_assert(std::is_same_v, + "Container should have same the schema as Message"); + + friend class builder; + friend class reader; + +public: + class reader; + class builder { + private: + MessageType &message_; + + public: + builder(MessageType &msg) : message_{msg} {} + + reader as_reader() { return reader{message_}; } + + void set(std::string &&str) { message_.container_.set(std::move(str)); } + void set(const std::string_view str) { message_.container_.set(str); } + void set(const char *str) { set(std::string_view{str}); } + }; + + class reader { + private: + MessageType &message_; + + public: + reader(MessageType &msg) : message_{msg} {} + + builder as_builder() { return builder{message_}; } + + const std::string_view get() const { return message_.container_.get(); } + }; +}; + +template > +class heap_message_root { +private: + own> root_; + +public: + heap_message_root(own> r) + : root_{std::move(r)} {} + + typename message::builder build() { + assert(root_); + return typename message::builder{*root_}; + } + + typename message::reader read() { + assert(root_); + return typename message::reader{*root_}; + } +}; + +template +class heap_message_root, Container> { +public: + using Schema = schema::Array; + +private: + own> root_; + +public: + heap_message_root(own> r) + : root_{std::move(r)} {} + + typename message::builder build(size_t size) { + assert(root_); + return typename message::builder{*root_, size}; + } + + typename message::reader read() { + assert(root_); + return typename message::reader{*root_}; + } +}; + +/* + * Minor helper for creating a message root + */ +template > +inline heap_message_root new_heap_message_root() { + own> root = heap>(); + return heap_message_root{std::move(root)}; +} +} // namespace saw diff --git a/forstio/codec/message_container.h b/forstio/codec/message_container.h new file mode 100644 index 0000000..191052a --- /dev/null +++ b/forstio/codec/message_container.h @@ -0,0 +1,246 @@ +#pragma once + +#include "schema.h" + +#include +#include + +namespace saw { +template class message_container; + +template > class message; + +template struct message_parameter_pack_type; + +template +struct message_parameter_pack_type<0, TN, T...> { + using Type = TN; +}; + +template +struct message_parameter_pack_type { + static_assert(sizeof...(T) > 0, "Exhausted parameters"); + using Type = typename message_parameter_pack_type::Type; +}; + +template struct MessageParameterPackIndex; + +template struct MessageParameterPackIndex { + static constexpr size_t Value = 0u; +}; + +template +struct MessageParameterPackIndex { + static constexpr size_t Value = + 1u + MessageParameterPackIndex::Value; +}; + +/* + * Nightmare inducing compiler problems found here. Somehow non-type + * StringLiterals cannot be resolved as non-type primitive template values can. + * This is the workaround + */ +template +struct message_parameter_key_pack_index_helper { + static constexpr size_t Value = + (V == Key0) + ? (0u) + : (1u + message_parameter_key_pack_index_helper::Value); +}; + +template +struct message_parameter_key_pack_index_helper { + static constexpr size_t Value = (V == Key0) ? (0u) : (1u); +}; + +template +struct message_parameter_key_pack_index { + static constexpr size_t Value = + message_parameter_key_pack_index_helper::Value; + static_assert(Value < sizeof...(Keys), + "Provided StringLiteral doesn't exist in searched list"); +}; + +template struct schema_is_array { + constexpr static bool Value = false; +}; + +template struct schema_is_array> { + constexpr static bool Value = true; +}; + +template +class message_container...>> { +private: + using ValueType = std::tuple>...>; + ValueType values_; + +public: + using SchemaType = schema::Struct...>; + + template + using ElementType = typename message_parameter_pack_type< + i, message>...>::Type; + + template ElementType &get() { return std::get(values_); } +}; + +/* + * Union storage + */ +template +class message_container...>> { +private: + using ValueType = std::variant>...>; + ValueType value_; + +public: + using SchemaType = schema::Union...>; + + template + using ElementType = typename message_parameter_pack_type< + i, message>...>::Type; + + template ElementType &get() { + if (i != value_.index()) { + using MessageIV = + typename message_parameter_pack_type::Type; + value_ = message>{}; + } + return std::get(value_); + } + + size_t index() const noexcept { return value_.index(); } +}; + +/* + * Array storage + */ + +template class message_container> { +private: + using ValueType = std::vector>>; + ValueType values_; + +public: + using SchemaType = schema::Array; + + using ElementType = message>; + + message> &get(size_t index) { + return values_.at(index); + } + + void resize(size_t size) { values_.resize(size); } + + size_t size() const { return values_.size(); } +}; + +/* + * Tuple storage + */ +template class message_container> { +private: + using ValueType = std::tuple>...>; + ValueType values_; + +public: + using SchemaType = schema::Tuple; + + template + using ElementType = typename message_parameter_pack_type< + i, message>...>::Type; + + template ElementType &get() { return std::get(values_); } +}; + +/* + * Helper for the basic message container, so the class doesn't have to be + * specialized 10 times. + */ +template struct PrimitiveTypeHelper; + +template <> +struct PrimitiveTypeHelper> { + using Type = int8_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = int16_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = int32_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = int64_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = uint8_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = uint16_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = uint32_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = uint64_t; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = float; +}; + +template <> +struct PrimitiveTypeHelper> { + using Type = double; +}; + +template class message_container> { +public: + using SchemaType = schema::Primitive; + using ValueType = + typename PrimitiveTypeHelper>::Type; + +private: + ValueType value_; + +public: + message_container() : value_{0} {} + + void set(const ValueType &v) { value_ = v; } + + const ValueType &get() const { return value_; } +}; + +template <> class message_container { +public: + using SchemaType = schema::String; + using ValueType = std::string; + using ValueViewType = std::string_view; + +private: + ValueType value_; + +public: + void set(ValueType &&v) { value_ = std::move(v); } + void set(const ValueType &v) { value_ = v; } + void set(const ValueViewType v) { value_ = std::string{v}; } + + const ValueType &get() const { return value_; } +}; +} // namespace saw diff --git a/forstio/codec/schema.h b/forstio/codec/schema.h new file mode 100644 index 0000000..915e4eb --- /dev/null +++ b/forstio/codec/schema.h @@ -0,0 +1,77 @@ +#pragma once + +#include +#include + +namespace saw { +namespace schema { +// NOLINTBEGIN +template struct NamedMember {}; + +template struct Struct { + static_assert( + always_false, + "This schema template doesn't support this type of template argument"); +}; + +template +struct Struct...> {}; + +template struct Union { + static_assert( + always_false, + "This schema template doesn't support this type of template argument"); +}; + +template +struct Union...> {}; + +template struct Array {}; + +template struct Tuple {}; + +struct String {}; + +struct SignedInteger {}; +struct UnsignedInteger {}; +struct FloatingPoint {}; + +template struct Primitive { + static_assert(((std::is_same_v || + std::is_same_v)&&(N == 1 || N == 2 || + N == 4 || N == 8)) || + (std::is_same_v && (N == 4 || N == 8)), + "Primitive Type is not supported"); +}; + +using Int8 = Primitive; +using Int16 = Primitive; +using Int32 = Primitive; +using Int64 = Primitive; + +using UInt8 = Primitive; +using UInt16 = Primitive; +using UInt32 = Primitive; +using UInt64 = Primitive; + +using Float32 = Primitive; +using Float64 = Primitive; + +/** + * Classes enabling Rpc calls + */ +template +struct Function {}; + +template struct Interface { + static_assert( + always_false, + "This schema template doesn't support this type of template argument"); +}; + +template +struct Interface...> {}; + +// NOLINTEND +} // namespace schema +} // namespace saw diff --git a/forstio/core/SConscript b/forstio/core/SConscript index 9bbc8dc..04eb4c3 100644 --- a/forstio/core/SConscript +++ b/forstio/core/SConscript @@ -35,4 +35,4 @@ env.targets += ['library_core']; # Install env.Install('$prefix/lib/', [core_env.library_shared, core_env.library_static]); -env.Install('$prefix/include/forstio/', [core_env.headers]); +env.Install('$prefix/include/forstio/core/', [core_env.headers]); -- cgit v1.2.3