sr: Implement proper logging framework.

[libsigrok.git] / sigrok.h.in

diff --git a/sigrok.h.in b/sigrok.h.in
index 511f8afb3704bcec80aa7e317a3b600adbd7d628..a767dc71bceb980746a46ec412309076096a38da 100644 (file)
--- a/sigrok.h.in
+++ b/sigrok.h.in
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef SIGROK_SIGROK_H
-#define SIGROK_SIGROK_H
+#ifndef LIBSIGROK_SIGROK_H
+#define LIBSIGROK_SIGROK_H
 
 #include <stdio.h>
 #include <sys/time.h>
@@ -73,6 +73,25 @@ extern "C" {
 #define SR_LOG_DBG      4
 #define SR_LOG_SPEW     5
 
+/*
+ * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
+ *
+ * Variables and functions marked 'static' are private already and don't
+ * need SR_PRIV. However, functions which are not static (because they need
+ * to be used in other libsigrok-internal files) but are also not meant to
+ * be part of the public libsigrok API, must use SR_PRIV.
+ *
+ * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
+ *
+ * Details: http://gcc.gnu.org/wiki/Visibility
+ */
+
+/* Marks public libsigrok API symbols. */
+#define SR_API __attribute__((visibility("default")))
+
+/* Marks private, non-public libsigrok symbols (not part of the API). */
+#define SR_PRIV __attribute__((visibility("hidden")))
+
 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
 
 /* Data types used by hardware plugins for set_configuration() */
@@ -88,7 +107,6 @@ enum {
        SR_DF_END,
        SR_DF_TRIGGER,
        SR_DF_LOGIC,
-       SR_DF_ANALOG,
        SR_DF_PD,
 };
 
@@ -101,7 +119,6 @@ struct sr_datafeed_header {
        int feed_version;
        struct timeval starttime;
        uint64_t samplerate;
-       int num_analog_probes;
        int num_logic_probes;
 };
 
@@ -169,7 +186,6 @@ struct sr_device {
 
 enum {
        SR_PROBE_TYPE_LOGIC,
-       SR_PROBE_TYPE_ANALOG,
 };
 
 struct sr_probe {