Rename "event type" -> "event record type", "stream type" -> "data stream type"
[barectf.git] / barectf / templates / c / common.j2
index 10f064e32a99b2a9b851de9580017492d77b266a..09572669ca570bd4ee7eb044071b5bdada75f978 100644 (file)
@@ -1,3 +1,28 @@
+{#
+ # The MIT License (MIT)
+ #
+ # Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
+ #
+ # Permission is hereby granted, free of charge, to any person obtaining
+ # a copy of this software and associated documentation files (the
+ # "Software"), to deal in the Software without restriction, including
+ # without limitation the rights to use, copy, modify, merge, publish,
+ # distribute, sublicense, and/or sell copies of the Software, and to
+ # permit persons to whom the Software is furnished to do so, subject to
+ # the following conditions:
+ #
+ # The above copyright notice and this permission notice shall be
+ # included in all copies or substantial portions of the Software.
+ #
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ #}
+
 {#
  # Common variables and macros (for C templates).
  #}
 {% set ctx_struct_name %}{{ common.prefix }}ctx{% endset %}
 
 {#
- # Generates the name of a tracing function for the stream type
- # `stream_type` and the event type `ev_type`.
+ # Generates the name of a tracing function for the data stream type
+ # `dst` and the event record type `ert`.
  #
  # Example:
  #
  #     barectf_my_stream_trace_my_event
  #}
-{% macro trace_func_name(stream_type, ev_type) %}
-{{ common.prefix }}{{ stream_type.name }}_trace_{{ ev_type.name }}
+{% macro trace_func_name(dst, ert) %}
+{{ common.prefix }}{{ dst.name }}_trace_{{ ert.name }}
 {%- endmacro %}
 
 {#
- # Generates the name of a source variable from the names of the
- # operation `op`.
+ # Generates:
  #
- # Example:
+ # If `is_const` is `true`:
+ #     The string ` const `.
+ #
+ # Otherwise:
+ #     An empty string.
+ #}
+{% macro const_ptr_str(is_const) %}
+{{ ' const ' if is_const else '' }}
+{%- endmacro %}
+
+{#
+ # Generates:
+ #
+ # If `is_const` is `true`:
+ #     The string `const `.
  #
- #     ep_msg_id
+ # Otherwise:
+ #     An empty string.
+ #}
+{% macro const_str(is_const) %}
+{{ 'const ' if is_const else '' }}
+{%- endmacro %}
+
+{#
+ # Generates the length variable name of the dynamic field type
+ # operation `op`.
  #}
-{% macro op_src(op) %}
-{{ op.names | join('_') }}
+{% macro dyn_array_ft_op_len_var_name(op) %}
+{{ op.names[0] }}_{{ op.ft._length_ft_member_name }}
 {%- endmacro %}
This page took 0.034738 seconds and 4 git commands to generate.