barectf-tracepoint.h: improve quality

Changes:

* Reflow header comment to fit 72 columns.

* Capitalize comments.

* Use updated `barectf.h` definition names (`_BARECTF_IDENTIFIER_PREFIX`
  and `_BARECTF_DEFAULT_DATA_STREAM_TYPE_NAME`).

* Check for `BARECTF_TRACEPOINT_DATA_STREAM_TYPE_NAME` as an alternative
  to `BARECTF_TRACEPOINT_STREAM` (for consistency).

* Rework error messages.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/extra/barectf-tracepoint.h b/extra/barectf-tracepoint.h
index fb49a70938692ac97ff4df576b92120582b5e9ad..a045196dfa719b7e0e8594c7467fb2bc0c47478e 100644 (file)
--- a/extra/barectf-tracepoint.h
+++ b/extra/barectf-tracepoint.h
@@ -4,52 +4,56 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
+ * Copyright (c) 2016-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:
+ * 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 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.
+ * 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.
  */
 
-/* get prefix */
+/* Get identifier prefix */
 #ifdef BARECTF_TRACEPOINT_PREFIX
 # define _BARECTF_TRACEPOINT_PREFIX BARECTF_TRACEPOINT_PREFIX
 #else
-# ifdef _BARECTF_PREFIX
-#  define _BARECTF_TRACEPOINT_PREFIX _BARECTF_PREFIX
+# ifdef _BARECTF_IDENTIFIER_PREFIX
+#  define _BARECTF_TRACEPOINT_PREFIX _BARECTF_IDENTIFIER_PREFIX
 # else
-#  error You need to define BARECTF_TRACEPOINT_PREFIX in order to use this header.
+#  error You must define `BARECTF_TRACEPOINT_PREFIX` to use this header.
 # endif
 #endif
 
-/* get stream name to use */
+/* Get data stream type name to use */
 #ifdef BARECTF_TRACEPOINT_STREAM
-# define _BARECTF_TRACEPOINT_STREAM BARECTF_TRACEPOINT_STREAM
+# define _BARECTF_TRACEPOINT_DST_NAME BARECTF_TRACEPOINT_STREAM
+#elif defined(BARECTF_TRACEPOINT_DATA_STREAM_TYPE_NAME)
+# define _BARECTF_TRACEPOINT_DST_NAME BARECTF_TRACEPOINT_DATA_STREAM_TYPE_NAME
 #else
-# ifdef _BARECTF_DEFAULT_STREAM
-#  define _BARECTF_TRACEPOINT_STREAM _BARECTF_DEFAULT_STREAM
+# ifdef _BARECTF_DEFAULT_DATA_STREAM_TYPE_NAME
+#  define _BARECTF_TRACEPOINT_DST_NAME _BARECTF_DEFAULT_DATA_STREAM_TYPE_NAME
 # else
-#  error You need to define BARECTF_TRACEPOINT_STREAM in order to use this header.
+#  error You must define `BARECTF_TRACEPOINT_DATA_STREAM_TYPE_NAME` to use this header.
 # endif
 #endif
 
-/* get context to use */
+/* Get context to use */
 #ifndef BARECTF_TRACEPOINT_CTX
-# error You need to define BARECTF_TRACEPOINT_CTX in order to use this header.
+# error You must define `BARECTF_TRACEPOINT_CTX` to use this header.
 #endif
 
 /*
@@ -65,6 +69,6 @@
 /* tracepoint() used by the user */
 #undef tracepoint
 #define tracepoint(_prov_name, _tp_name, ...) \
-       _COMBINE_TOKENS6(_BARECTF_TRACEPOINT_PREFIX, _BARECTF_TRACEPOINT_STREAM, _trace_, _prov_name, _, _tp_name)(BARECTF_TRACEPOINT_CTX, ##__VA_ARGS__)
+       _COMBINE_TOKENS6(_BARECTF_TRACEPOINT_PREFIX, _BARECTF_TRACEPOINT_DST_NAME, _trace_, _prov_name, _, _tp_name)(BARECTF_TRACEPOINT_CTX, ##__VA_ARGS__)
 
 #endif /* _BARECTF_TRACEPOINT_H */