barectf/templates/c/common.j2

   1 {#
   2  # The MIT License (MIT)
   3  #
   4  # Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
   5  #
   6  # Permission is hereby granted, free of charge, to any person obtaining
   7  # a copy of this software and associated documentation files (the
   8  # "Software"), to deal in the Software without restriction, including
   9  # without limitation the rights to use, copy, modify, merge, publish,
  10  # distribute, sublicense, and/or sell copies of the Software, and to
  11  # permit persons to whom the Software is furnished to do so, subject to
  12  # the following conditions:
  13  #
  14  # The above copyright notice and this permission notice shall be
  15  # included in all copies or substantial portions of the Software.
  16  #
  17  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20  # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21  # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  #}
  25
  26 {#
  27  # Common variables and macros (for C templates).
  28  #}
  29
  30 {% import 'common.j2' as common %}
  31
  32 {# generic barectf context structure name #}
  33 {% set ctx_struct_name %}{{ common.prefix }}ctx{% endset %}
  34
  35 {#
  36  # Generates the name of a tracing function for the stream type
  37  # `stream_type` and the event type `ev_type`.
  38  #
  39  # Example:
  40  #
  41  #     barectf_my_stream_trace_my_event
  42  #}
  43 {% macro trace_func_name(stream_type, ev_type) %}
  44 {{ common.prefix }}{{ stream_type.name }}_trace_{{ ev_type.name }}
  45 {%- endmacro %}
  46
  47 {#
  48  # Generates the name of a source variable from the names of the
  49  # operation `op`.
  50  #
  51  # Example:
  52  #
  53  #     p_msg_id
  54  #}
  55 {% macro op_src(op) %}
  56 {{ op.names | join('_') }}
  57 {%- endmacro %}