src/cpp-common/bt2/wrap.hpp

   1 /*
   2  * Copyright (c) 2023 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * SPDX-License-Identifier: MIT
   5  */
   6
   7 #ifndef BABELTRACE_CPP_COMMON_BT2_WRAP_HPP
   8 #define BABELTRACE_CPP_COMMON_BT2_WRAP_HPP
   9
  10 #include <babeltrace2/babeltrace.h>
  11
  12 #include "clock-class.hpp"
  13 #include "clock-snapshot.hpp"
  14 #include "component-port.hpp"
  15 #include "field-class.hpp"
  16 #include "field.hpp"
  17 #include "integer-range-set.hpp"
  18 #include "integer-range.hpp"
  19 #include "message-iterator.hpp"
  20 #include "message.hpp"
  21 #include "optional-borrowed-object.hpp"
  22 #include "private-query-executor.hpp"
  23 #include "self-component-class.hpp"
  24 #include "self-component-port.hpp"
  25 #include "self-message-iterator-configuration.hpp"
  26 #include "self-message-iterator.hpp"
  27 #include "trace-ir.hpp"
  28 #include "value.hpp"
  29
  30 namespace bt2 {
  31
  32 inline ClockClass wrap(bt_clock_class * const libObjPtr) noexcept
  33 {
  34     return ClockClass {libObjPtr};
  35 }
  36
  37 inline ConstClockClass wrap(const bt_clock_class * const libObjPtr) noexcept
  38 {
  39     return ConstClockClass {libObjPtr};
  40 }
  41
  42 inline ConstClockSnapshot wrap(const bt_clock_snapshot * const libObjPtr) noexcept
  43 {
  44     return ConstClockSnapshot {libObjPtr};
  45 }
  46
  47 inline ConstComponent wrap(const bt_component * const libObjPtr) noexcept
  48 {
  49     return ConstComponent {libObjPtr};
  50 }
  51
  52 inline ConstSourceComponent wrap(const bt_component_source * const libObjPtr) noexcept
  53 {
  54     return ConstSourceComponent {libObjPtr};
  55 }
  56
  57 inline ConstFilterComponent wrap(const bt_component_filter * const libObjPtr) noexcept
  58 {
  59     return ConstFilterComponent {libObjPtr};
  60 }
  61
  62 inline ConstSinkComponent wrap(const bt_component_sink * const libObjPtr) noexcept
  63 {
  64     return ConstSinkComponent {libObjPtr};
  65 }
  66
  67 inline ConstInputPort wrap(const bt_port_input * const libObjPtr) noexcept
  68 {
  69     return ConstInputPort {libObjPtr};
  70 }
  71
  72 inline ConstOutputPort wrap(const bt_port_output * const libObjPtr) noexcept
  73 {
  74     return ConstOutputPort {libObjPtr};
  75 }
  76
  77 inline FieldClass wrap(bt_field_class * const libObjPtr) noexcept
  78 {
  79     return FieldClass {libObjPtr};
  80 }
  81
  82 inline ConstFieldClass wrap(const bt_field_class * const libObjPtr) noexcept
  83 {
  84     return ConstFieldClass {libObjPtr};
  85 }
  86
  87 inline ConstFieldPathItem wrap(const bt_field_path_item * const libObjPtr) noexcept
  88 {
  89     return ConstFieldPathItem {libObjPtr};
  90 }
  91
  92 inline ConstFieldPath wrap(const bt_field_path * const libObjPtr) noexcept
  93 {
  94     return ConstFieldPath {libObjPtr};
  95 }
  96
  97 inline Field wrap(bt_field * const libObjPtr) noexcept
  98 {
  99     return Field {libObjPtr};
 100 }
 101
 102 inline ConstField wrap(const bt_field * const libObjPtr) noexcept
 103 {
 104     return ConstField {libObjPtr};
 105 }
 106
 107 inline UnsignedIntegerRangeSet wrap(bt_integer_range_set_unsigned * const libObjPtr) noexcept
 108 {
 109     return UnsignedIntegerRangeSet {libObjPtr};
 110 }
 111
 112 inline ConstUnsignedIntegerRangeSet
 113 wrap(const bt_integer_range_set_unsigned * const libObjPtr) noexcept
 114 {
 115     return ConstUnsignedIntegerRangeSet {libObjPtr};
 116 }
 117
 118 inline SignedIntegerRangeSet wrap(bt_integer_range_set_signed * const libObjPtr) noexcept
 119 {
 120     return SignedIntegerRangeSet {libObjPtr};
 121 }
 122
 123 inline ConstSignedIntegerRangeSet wrap(const bt_integer_range_set_signed * const libObjPtr) noexcept
 124 {
 125     return ConstSignedIntegerRangeSet {libObjPtr};
 126 }
 127
 128 inline ConstUnsignedIntegerRange wrap(const bt_integer_range_unsigned * const libObjPtr) noexcept
 129 {
 130     return ConstUnsignedIntegerRange {libObjPtr};
 131 }
 132
 133 inline ConstSignedIntegerRange wrap(const bt_integer_range_signed * const libObjPtr) noexcept
 134 {
 135     return ConstSignedIntegerRange {libObjPtr};
 136 }
 137
 138 inline MessageIterator wrap(bt_message_iterator * const libObjPtr) noexcept
 139 {
 140     return MessageIterator {libObjPtr};
 141 }
 142
 143 inline Message wrap(bt_message * const libObjPtr) noexcept
 144 {
 145     return Message {libObjPtr};
 146 }
 147
 148 inline ConstMessage wrap(const bt_message * const libObjPtr) noexcept
 149 {
 150     return ConstMessage {libObjPtr};
 151 }
 152
 153 inline PrivateQueryExecutor wrap(bt_private_query_executor * const libObjPtr) noexcept
 154 {
 155     return PrivateQueryExecutor {libObjPtr};
 156 }
 157
 158 inline SelfComponentClass wrap(bt_self_component_class * const libObjPtr) noexcept
 159 {
 160     return SelfComponentClass {libObjPtr};
 161 }
 162
 163 inline SelfComponentClass wrap(bt_self_component_class_source * const libObjPtr) noexcept
 164 {
 165     return SelfComponentClass {libObjPtr};
 166 }
 167
 168 inline SelfComponentClass wrap(bt_self_component_class_filter * const libObjPtr) noexcept
 169 {
 170     return SelfComponentClass {libObjPtr};
 171 }
 172
 173 inline SelfComponentClass wrap(bt_self_component_class_sink * const libObjPtr) noexcept
 174 {
 175     return SelfComponentClass {libObjPtr};
 176 }
 177
 178 inline SelfComponent wrap(bt_self_component * const libObjPtr) noexcept
 179 {
 180     return SelfComponent {libObjPtr};
 181 }
 182
 183 inline SelfSourceComponent wrap(bt_self_component_source * const libObjPtr) noexcept
 184 {
 185     return SelfSourceComponent {libObjPtr};
 186 }
 187
 188 inline SelfFilterComponent wrap(bt_self_component_filter * const libObjPtr) noexcept
 189 {
 190     return SelfFilterComponent {libObjPtr};
 191 }
 192
 193 inline SelfSinkComponent wrap(bt_self_component_sink * const libObjPtr) noexcept
 194 {
 195     return SelfSinkComponent {libObjPtr};
 196 }
 197
 198 inline SelfComponentInputPort wrap(bt_self_component_port_input * const libObjPtr) noexcept
 199 {
 200     return SelfComponentInputPort {libObjPtr};
 201 }
 202
 203 inline SelfComponentOutputPort wrap(bt_self_component_port_output * const libObjPtr) noexcept
 204 {
 205     return SelfComponentOutputPort {libObjPtr};
 206 }
 207
 208 inline SelfMessageIterator wrap(bt_self_message_iterator * const libObjPtr) noexcept
 209 {
 210     return SelfMessageIterator {libObjPtr};
 211 }
 212
 213 inline SelfMessageIteratorConfiguration
 214 wrap(bt_self_message_iterator_configuration * const libObjPtr) noexcept
 215 {
 216     return SelfMessageIteratorConfiguration {libObjPtr};
 217 }
 218
 219 inline Event wrap(bt_event * const libObjPtr) noexcept
 220 {
 221     return Event {libObjPtr};
 222 }
 223
 224 inline ConstEvent wrap(const bt_event * const libObjPtr) noexcept
 225 {
 226     return ConstEvent {libObjPtr};
 227 }
 228
 229 inline Packet wrap(bt_packet * const libObjPtr) noexcept
 230 {
 231     return Packet {libObjPtr};
 232 }
 233
 234 inline ConstPacket wrap(const bt_packet * const libObjPtr) noexcept
 235 {
 236     return ConstPacket {libObjPtr};
 237 }
 238
 239 inline Stream wrap(bt_stream * const libObjPtr) noexcept
 240 {
 241     return Stream {libObjPtr};
 242 }
 243
 244 inline ConstStream wrap(const bt_stream * const libObjPtr) noexcept
 245 {
 246     return ConstStream {libObjPtr};
 247 }
 248
 249 inline Trace wrap(bt_trace * const libObjPtr) noexcept
 250 {
 251     return Trace {libObjPtr};
 252 }
 253
 254 inline ConstTrace wrap(const bt_trace * const libObjPtr) noexcept
 255 {
 256     return ConstTrace {libObjPtr};
 257 }
 258
 259 inline EventClass wrap(bt_event_class * const libObjPtr) noexcept
 260 {
 261     return EventClass {libObjPtr};
 262 }
 263
 264 inline ConstEventClass wrap(const bt_event_class * const libObjPtr) noexcept
 265 {
 266     return ConstEventClass {libObjPtr};
 267 }
 268
 269 inline StreamClass wrap(bt_stream_class * const libObjPtr) noexcept
 270 {
 271     return StreamClass {libObjPtr};
 272 }
 273
 274 inline ConstStreamClass wrap(const bt_stream_class * const libObjPtr) noexcept
 275 {
 276     return ConstStreamClass {libObjPtr};
 277 }
 278
 279 inline TraceClass wrap(bt_trace_class * const libObjPtr) noexcept
 280 {
 281     return TraceClass {libObjPtr};
 282 }
 283
 284 inline ConstTraceClass wrap(const bt_trace_class * const libObjPtr) noexcept
 285 {
 286     return ConstTraceClass {libObjPtr};
 287 }
 288
 289 inline Value wrap(bt_value * const libObjPtr) noexcept
 290 {
 291     return Value {libObjPtr};
 292 }
 293
 294 inline ConstValue wrap(const bt_value * const libObjPtr) noexcept
 295 {
 296     return ConstValue {libObjPtr};
 297 }
 298
 299 inline OptionalBorrowedObject<ClockClass> wrapOptional(bt_clock_class * const libObjPtr) noexcept
 300 {
 301     return libObjPtr;
 302 }
 303
 304 inline OptionalBorrowedObject<ConstClockClass>
 305 wrapOptional(const bt_clock_class * const libObjPtr) noexcept
 306 {
 307     return libObjPtr;
 308 }
 309
 310 inline OptionalBorrowedObject<ConstClockSnapshot>
 311 wrapOptional(const bt_clock_snapshot * const libObjPtr) noexcept
 312 {
 313     return libObjPtr;
 314 }
 315
 316 inline OptionalBorrowedObject<ConstComponent>
 317 wrapOptional(const bt_component * const libObjPtr) noexcept
 318 {
 319     return libObjPtr;
 320 }
 321
 322 inline OptionalBorrowedObject<ConstSourceComponent>
 323 wrapOptional(const bt_component_source * const libObjPtr) noexcept
 324 {
 325     return libObjPtr;
 326 }
 327
 328 inline OptionalBorrowedObject<ConstFilterComponent>
 329 wrapOptional(const bt_component_filter * const libObjPtr) noexcept
 330 {
 331     return libObjPtr;
 332 }
 333
 334 inline OptionalBorrowedObject<ConstSinkComponent>
 335 wrapOptional(const bt_component_sink * const libObjPtr) noexcept
 336 {
 337     return libObjPtr;
 338 }
 339
 340 inline OptionalBorrowedObject<ConstInputPort>
 341 wrapOptional(const bt_port_input * const libObjPtr) noexcept
 342 {
 343     return libObjPtr;
 344 }
 345
 346 inline OptionalBorrowedObject<ConstOutputPort>
 347 wrapOptional(const bt_port_output * const libObjPtr) noexcept
 348 {
 349     return libObjPtr;
 350 }
 351
 352 inline OptionalBorrowedObject<FieldClass> wrapOptional(bt_field_class * const libObjPtr) noexcept
 353 {
 354     return libObjPtr;
 355 }
 356
 357 inline OptionalBorrowedObject<ConstFieldClass>
 358 wrapOptional(const bt_field_class * const libObjPtr) noexcept
 359 {
 360     return libObjPtr;
 361 }
 362
 363 inline OptionalBorrowedObject<ConstFieldPathItem>
 364 wrapOptional(const bt_field_path_item * const libObjPtr) noexcept
 365 {
 366     return libObjPtr;
 367 }
 368
 369 inline OptionalBorrowedObject<ConstFieldPath>
 370 wrapOptional(const bt_field_path * const libObjPtr) noexcept
 371 {
 372     return libObjPtr;
 373 }
 374
 375 inline OptionalBorrowedObject<Field> wrapOptional(bt_field * const libObjPtr) noexcept
 376 {
 377     return libObjPtr;
 378 }
 379
 380 inline OptionalBorrowedObject<ConstField> wrapOptional(const bt_field * const libObjPtr) noexcept
 381 {
 382     return libObjPtr;
 383 }
 384
 385 inline OptionalBorrowedObject<UnsignedIntegerRangeSet>
 386 wrapOptional(bt_integer_range_set_unsigned * const libObjPtr) noexcept
 387 {
 388     return libObjPtr;
 389 }
 390
 391 inline OptionalBorrowedObject<ConstUnsignedIntegerRangeSet>
 392 wrapOptional(const bt_integer_range_set_unsigned * const libObjPtr) noexcept
 393 {
 394     return libObjPtr;
 395 }
 396
 397 inline OptionalBorrowedObject<SignedIntegerRangeSet>
 398 wrapOptional(bt_integer_range_set_signed * const libObjPtr) noexcept
 399 {
 400     return libObjPtr;
 401 }
 402
 403 inline OptionalBorrowedObject<ConstSignedIntegerRangeSet>
 404 wrapOptional(const bt_integer_range_set_signed * const libObjPtr) noexcept
 405 {
 406     return libObjPtr;
 407 }
 408
 409 inline OptionalBorrowedObject<ConstUnsignedIntegerRange>
 410 wrapOptional(const bt_integer_range_unsigned * const libObjPtr) noexcept
 411 {
 412     return libObjPtr;
 413 }
 414
 415 inline OptionalBorrowedObject<ConstSignedIntegerRange>
 416 wrapOptional(const bt_integer_range_signed * const libObjPtr) noexcept
 417 {
 418     return libObjPtr;
 419 }
 420
 421 inline OptionalBorrowedObject<MessageIterator>
 422 wrapOptional(bt_message_iterator * const libObjPtr) noexcept
 423 {
 424     return libObjPtr;
 425 }
 426
 427 inline OptionalBorrowedObject<Message> wrapOptional(bt_message * const libObjPtr) noexcept
 428 {
 429     return libObjPtr;
 430 }
 431
 432 inline OptionalBorrowedObject<ConstMessage>
 433 wrapOptional(const bt_message * const libObjPtr) noexcept
 434 {
 435     return libObjPtr;
 436 }
 437
 438 inline OptionalBorrowedObject<PrivateQueryExecutor>
 439 wrapOptional(bt_private_query_executor * const libObjPtr) noexcept
 440 {
 441     return libObjPtr;
 442 }
 443
 444 inline OptionalBorrowedObject<SelfComponentClass>
 445 wrapOptional(bt_self_component_class * const libObjPtr) noexcept
 446 {
 447     return libObjPtr;
 448 }
 449
 450 inline OptionalBorrowedObject<SelfComponentClass>
 451 wrapOptional(bt_self_component_class_source * const libObjPtr) noexcept
 452 {
 453     return bt_self_component_class_source_as_self_component_class(libObjPtr);
 454 }
 455
 456 inline OptionalBorrowedObject<SelfComponentClass>
 457 wrapOptional(bt_self_component_class_filter * const libObjPtr) noexcept
 458 {
 459     return bt_self_component_class_filter_as_self_component_class(libObjPtr);
 460 }
 461
 462 inline OptionalBorrowedObject<SelfComponentClass>
 463 wrapOptional(bt_self_component_class_sink * const libObjPtr) noexcept
 464 {
 465     return bt_self_component_class_sink_as_self_component_class(libObjPtr);
 466 }
 467
 468 inline OptionalBorrowedObject<SelfComponent>
 469 wrapOptional(bt_self_component * const libObjPtr) noexcept
 470 {
 471     return libObjPtr;
 472 }
 473
 474 inline OptionalBorrowedObject<SelfSourceComponent>
 475 wrapOptional(bt_self_component_source * const libObjPtr) noexcept
 476 {
 477     return libObjPtr;
 478 }
 479
 480 inline OptionalBorrowedObject<SelfFilterComponent>
 481 wrapOptional(bt_self_component_filter * const libObjPtr) noexcept
 482 {
 483     return libObjPtr;
 484 }
 485
 486 inline OptionalBorrowedObject<SelfSinkComponent>
 487 wrapOptional(bt_self_component_sink * const libObjPtr) noexcept
 488 {
 489     return libObjPtr;
 490 }
 491
 492 inline OptionalBorrowedObject<SelfComponentInputPort>
 493 wrapOptional(bt_self_component_port_input * const libObjPtr) noexcept
 494 {
 495     return libObjPtr;
 496 }
 497
 498 inline OptionalBorrowedObject<SelfComponentOutputPort>
 499 wrapOptional(bt_self_component_port_output * const libObjPtr) noexcept
 500 {
 501     return libObjPtr;
 502 }
 503
 504 inline OptionalBorrowedObject<SelfMessageIterator>
 505 wrapOptional(bt_self_message_iterator * const libObjPtr) noexcept
 506 {
 507     return libObjPtr;
 508 }
 509
 510 inline OptionalBorrowedObject<SelfMessageIteratorConfiguration>
 511 wrapOptional(bt_self_message_iterator_configuration * const libObjPtr) noexcept
 512 {
 513     return libObjPtr;
 514 }
 515
 516 inline OptionalBorrowedObject<Event> wrapOptional(bt_event * const libObjPtr) noexcept
 517 {
 518     return libObjPtr;
 519 }
 520
 521 inline OptionalBorrowedObject<ConstEvent> wrapOptional(const bt_event * const libObjPtr) noexcept
 522 {
 523     return libObjPtr;
 524 }
 525
 526 inline OptionalBorrowedObject<Packet> wrapOptional(bt_packet * const libObjPtr) noexcept
 527 {
 528     return libObjPtr;
 529 }
 530
 531 inline OptionalBorrowedObject<ConstPacket> wrapOptional(const bt_packet * const libObjPtr) noexcept
 532 {
 533     return libObjPtr;
 534 }
 535
 536 inline OptionalBorrowedObject<Stream> wrapOptional(bt_stream * const libObjPtr) noexcept
 537 {
 538     return libObjPtr;
 539 }
 540
 541 inline OptionalBorrowedObject<ConstStream> wrapOptional(const bt_stream * const libObjPtr) noexcept
 542 {
 543     return libObjPtr;
 544 }
 545
 546 inline OptionalBorrowedObject<Trace> wrapOptional(bt_trace * const libObjPtr) noexcept
 547 {
 548     return libObjPtr;
 549 }
 550
 551 inline OptionalBorrowedObject<ConstTrace> wrapOptional(const bt_trace * const libObjPtr) noexcept
 552 {
 553     return libObjPtr;
 554 }
 555
 556 inline OptionalBorrowedObject<EventClass> wrapOptional(bt_event_class * const libObjPtr) noexcept
 557 {
 558     return libObjPtr;
 559 }
 560
 561 inline OptionalBorrowedObject<ConstEventClass>
 562 wrapOptional(const bt_event_class * const libObjPtr) noexcept
 563 {
 564     return libObjPtr;
 565 }
 566
 567 inline OptionalBorrowedObject<StreamClass> wrapOptional(bt_stream_class * const libObjPtr) noexcept
 568 {
 569     return libObjPtr;
 570 }
 571
 572 inline OptionalBorrowedObject<ConstStreamClass>
 573 wrapOptional(const bt_stream_class * const libObjPtr) noexcept
 574 {
 575     return libObjPtr;
 576 }
 577
 578 inline OptionalBorrowedObject<TraceClass> wrapOptional(bt_trace_class * const libObjPtr) noexcept
 579 {
 580     return libObjPtr;
 581 }
 582
 583 inline OptionalBorrowedObject<ConstTraceClass>
 584 wrapOptional(const bt_trace_class * const libObjPtr) noexcept
 585 {
 586     return libObjPtr;
 587 }
 588
 589 inline OptionalBorrowedObject<Value> wrapOptional(bt_value * const libObjPtr) noexcept
 590 {
 591     return libObjPtr;
 592 }
 593
 594 inline OptionalBorrowedObject<ConstValue> wrapOptional(const bt_value * const libObjPtr) noexcept
 595 {
 596     return libObjPtr;
 597 }
 598
 599 } /* namespace bt2 */
 600
 601 #endif /* BABELTRACE_CPP_COMMON_BT2_WRAP_HPP */