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