doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab

[babeltrace.git] / src / plugins / ctf / fs-src / fs.hpp

diff --git a/src/plugins/ctf/fs-src/fs.hpp b/src/plugins/ctf/fs-src/fs.hpp
index bd9bfb9767e9a6292eb450c7883a13816840d7d1..c9ca2a90be0dd093086a89c6ced1f38d3eaedfa7 100644 (file)
--- a/src/plugins/ctf/fs-src/fs.hpp
+++ b/src/plugins/ctf/fs-src/fs.hpp
@@ -14,7 +14,6 @@
 
 #include <babeltrace2/babeltrace.h>
 
-#include "cpp-common/bt2c/glib-up.hpp"
 #include "cpp-common/bt2c/logging.hpp"
 
 #include "data-stream-file.hpp"
@@ -37,14 +36,9 @@ struct ctf_fs_metadata
     int bo = 0;
 };
 
-struct ctf_fs_trace_deleter
-{
-    void operator()(ctf_fs_trace *) noexcept;
-};
-
 struct ctf_fs_trace
 {
-    using UP = std::unique_ptr<ctf_fs_trace, ctf_fs_trace_deleter>;
+    using UP = std::unique_ptr<ctf_fs_trace>;
 
     explicit ctf_fs_trace(const bt2c::Logger& parentLogger) :
         logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"}
@@ -80,8 +74,10 @@ struct ctf_fs_component
 {
     using UP = std::unique_ptr<ctf_fs_component>;
 
-    explicit ctf_fs_component(const bt2c::Logger& parentLogger) noexcept :
-        logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"}
+    explicit ctf_fs_component(const ctf::src::ClkClsCfg& clkClsCfgParam,
+                              const bt2c::Logger& parentLogger) noexcept :
+        logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"},
+        clkClsCfg {clkClsCfgParam}
     {
     }
 
@@ -151,10 +147,6 @@ ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const
 bt_message_iterator_class_seek_beginning_method_status
 ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator);
 
-/* Create and initialize a new, empty ctf_fs_component. */
-
-ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger);
-
 /*
  * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
  * the same UUID.
@@ -168,32 +160,43 @@ ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger);
  */
 
 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs,
-                                         const bt_value *paths_value,
-                                         const bt_value *trace_name_value,
+                                         bt2::ConstArrayValue pathsValue, const char *traceName,
                                          bt_self_component *selfComp);
 
+namespace ctf {
+namespace src {
+namespace fs {
+
+/* `src.ctf.fs` parameters */
+
+struct Parameters
+{
+    explicit Parameters(const bt2::ConstArrayValue inputsParam) noexcept : inputs {inputsParam}
+    {
+    }
+
+    bt2::ConstArrayValue inputs;
+    bt2s::optional<std::string> traceName;
+    ClkClsCfg clkClsCfg;
+};
+
+} /* namespace fs */
+} /* namespace src */
+} /* namespace ctf */
+
 /*
  * Read and validate parameters taken by the src.ctf.fs plugin.
  *
- *  - The mandatory `paths` parameter is returned in `*paths`.
- *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
- *    present, are recorded in the `ctf_fs` structure.
- *  - The optional `trace-name` parameter is returned in `*trace_name` if
- *    present, else `*trace_name` is set to NULL.
- *
- * `self_comp` and `self_comp_class` are used for logging, only one of them
- * should be set.
- *
- * Return true on success, false if any parameter didn't pass validation.
+ * Throw if any parameter doesn't pass validation.
  */
 
-bool read_src_fs_parameters(const bt_value *params, const bt_value **paths,
-                            const bt_value **trace_name, struct ctf_fs_component *ctf_fs);
+ctf::src::fs::Parameters read_src_fs_parameters(bt2::ConstMapValue params,
+                                                const bt2c::Logger& logger);
 
 /*
  * Generate the port name to be used for a given data stream file group.
  */
 
-bt2c::GCharUP ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
+std::string ctf_fs_make_port_name(ctf_fs_ds_file_group *ds_file_group);
 
 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */