mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity

Specialise RETURN_VALUE macro into RETURN_{INT,STRING,POINTER}.

Browse Source 
This avoids the need to pass the required format string on every
call and also eliminates the need for the non-standard typeof() call.
This commit is contained in:
Martin Ling 2014-08-24 13:30:34 +01:00
parent 79a8004637
commit 9caa2e86aa
2 changed files with 47 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
libserialport_internal.h
View File

@ -176,9 +176,19 @@ extern void (*sp_debug_handler)(const char *format, ...);
#define RETURN_OK() RETURN_CODE(SP_OK); #define RETURN_OK() RETURN_CODE(SP_OK);
#define RETURN_ERROR(err, ...) do { DEBUG_ERROR(err, __VA_ARGS__); return err; } while (0) #define RETURN_ERROR(err, ...) do { DEBUG_ERROR(err, __VA_ARGS__); return err; } while (0)
#define RETURN_FAIL(...) do { DEBUG_FAIL(__VA_ARGS__); return SP_ERR_FAIL; } while (0) #define RETURN_FAIL(...) do { DEBUG_FAIL(__VA_ARGS__); return SP_ERR_FAIL; } while (0)
#define RETURN_VALUE(fmt, x) do { \ #define RETURN_INT(x) do { \
typeof(x) _x = x; \ int _x = x; \
DEBUG("%s returning " fmt, __func__, _x); \ DEBUG("%s returning %d", __func__, _x); \
return _x; \
} while (0)
#define RETURN_STRING(x) do { \
char *_x = x; \
DEBUG("%s returning %s", __func__, _x); \
return _x; \
} while (0)
#define RETURN_POINTER(x) do { \
void *_x = x; \
DEBUG("%s returning %p", __func__, _x); \
return _x; \ return _x; \
} while (0) } while (0)
#define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0) #define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)

68
serialport.c
View File

@ -120,7 +120,7 @@ SP_API char *sp_get_port_name(const struct sp_port *port)
if (!port) if (!port)
return NULL; return NULL;
RETURN_VALUE("%s", port->name); RETURN_STRING(port->name);
} }
SP_API char *sp_get_port_description(struct sp_port *port) SP_API char *sp_get_port_description(struct sp_port *port)
@ -130,7 +130,7 @@ SP_API char *sp_get_port_description(struct sp_port *port)
if (!port || !port->description) if (!port || !port->description)
return NULL; return NULL;
RETURN_VALUE("%s", port->description); RETURN_STRING(port->description);
} }
SP_API enum sp_transport sp_get_port_transport(struct sp_port *port) SP_API enum sp_transport sp_get_port_transport(struct sp_port *port)
@ -140,7 +140,7 @@ SP_API enum sp_transport sp_get_port_transport(struct sp_port *port)
if (!port) if (!port)
RETURN_ERROR(SP_ERR_ARG, "Null port"); RETURN_ERROR(SP_ERR_ARG, "Null port");
RETURN_VALUE("%d", port->transport); RETURN_INT(port->transport);
} }
SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port, SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
@ -186,7 +186,7 @@ SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer) if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
return NULL; return NULL;
RETURN_VALUE("%s", port->usb_manufacturer); RETURN_STRING(port->usb_manufacturer);
} }
SP_API char *sp_get_port_usb_product(const struct sp_port *port) SP_API char *sp_get_port_usb_product(const struct sp_port *port)
@ -196,7 +196,7 @@ SP_API char *sp_get_port_usb_product(const struct sp_port *port)
if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product) if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
return NULL; return NULL;
RETURN_VALUE("%s", port->usb_product); RETURN_STRING(port->usb_product);
} }
SP_API char *sp_get_port_usb_serial(const struct sp_port *port) SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
@ -206,7 +206,7 @@ SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial) if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
return NULL; return NULL;
RETURN_VALUE("%s", port->usb_serial); RETURN_STRING(port->usb_serial);
} }
SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port) SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
@ -217,7 +217,7 @@ SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
|| !port->bluetooth_address) || !port->bluetooth_address)
return NULL; return NULL;
RETURN_VALUE("%s", port->bluetooth_address); RETURN_STRING(port->bluetooth_address);
} }
SP_API enum sp_return sp_get_port_handle(const struct sp_port *port, SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
@ -257,7 +257,7 @@ SP_API enum sp_return sp_copy_port(const struct sp_port *port,
DEBUG("Copying port structure"); DEBUG("Copying port structure");
RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr)); RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
} }
SP_API void sp_free_port(struct sp_port *port) SP_API void sp_free_port(struct sp_port *port)
@ -683,7 +683,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
DEBUG("Writing %d bytes to port %s, no timeout", count, port->name); DEBUG("Writing %d bytes to port %s, no timeout", count, port->name);
if (count == 0) if (count == 0)
RETURN_VALUE("0", 0); RETURN_INT(0);
#ifdef _WIN32 #ifdef _WIN32
DWORD bytes_written = 0; DWORD bytes_written = 0;
@ -710,13 +710,13 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
DEBUG("Waiting for write to complete"); DEBUG("Waiting for write to complete");
GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE); GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
DEBUG("Write completed, %d/%d bytes written", bytes_written, count); DEBUG("Write completed, %d/%d bytes written", bytes_written, count);
RETURN_VALUE("%d", bytes_written); RETURN_INT(bytes_written);
} else { } else {
RETURN_FAIL("WriteFile() failed"); RETURN_FAIL("WriteFile() failed");
} }
} else { } else {
DEBUG("Write completed immediately"); DEBUG("Write completed immediately");
RETURN_VALUE("%d", count); RETURN_INT(count);
} }
#else #else
size_t bytes_written = 0; size_t bytes_written = 0;
@ -745,7 +745,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
gettimeofday(&now, NULL); gettimeofday(&now, NULL);
if (timercmp(&now, &end, >)) { if (timercmp(&now, &end, >)) {
DEBUG("write timed out"); DEBUG("write timed out");
RETURN_VALUE("%d", bytes_written); RETURN_INT(bytes_written);
} }
timersub(&end, &now, &delta); timersub(&end, &now, &delta);
} }
@ -759,7 +759,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
} }
} else if (result == 0) { } else if (result == 0) {
DEBUG("write timed out"); DEBUG("write timed out");
RETURN_VALUE("%d", bytes_written); RETURN_INT(bytes_written);
} }
/* Do write. */ /* Do write. */
@ -778,7 +778,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
ptr += result; ptr += result;
} }
RETURN_VALUE("%d", bytes_written); RETURN_INT(bytes_written);
#endif #endif
} }
@ -795,7 +795,7 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
DEBUG("Writing up to %d bytes to port %s", count, port->name); DEBUG("Writing up to %d bytes to port %s", count, port->name);
if (count == 0) if (count == 0)
RETURN_VALUE("0", 0); RETURN_INT(0);
#ifdef _WIN32 #ifdef _WIN32
DWORD written = 0; DWORD written = 0;
@ -809,7 +809,7 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
} else { } else {
DEBUG("Previous write not complete"); DEBUG("Previous write not complete");
/* Can't take a new write until the previous one finishes. */ /* Can't take a new write until the previous one finishes. */
RETURN_VALUE("0", 0); RETURN_INT(0);
} }
} }
@ -836,7 +836,7 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
} else { } else {
DEBUG("Asynchronous write running"); DEBUG("Asynchronous write running");
port->writing = 1; port->writing = 1;
RETURN_VALUE("%d", ++written); RETURN_INT(++written);
} }
} else { } else {
/* Actual failure of some kind. */ /* Actual failure of some kind. */
@ -850,7 +850,7 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
DEBUG("All bytes written immediately"); DEBUG("All bytes written immediately");
RETURN_VALUE("%d", written); RETURN_INT(written);
#else #else
/* Returns the number of bytes written, or -1 upon failure. */ /* Returns the number of bytes written, or -1 upon failure. */
ssize_t written = write(port->fd, buf, count); ssize_t written = write(port->fd, buf, count);
@ -858,7 +858,7 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
if (written < 0) if (written < 0)
RETURN_FAIL("write() failed"); RETURN_FAIL("write() failed");
else else
RETURN_VALUE("%d", written); RETURN_INT(written);
#endif #endif
} }
@ -878,7 +878,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
DEBUG("Reading %d bytes from port %s, no timeout", count, port->name); DEBUG("Reading %d bytes from port %s, no timeout", count, port->name);
if (count == 0) if (count == 0)
RETURN_VALUE("0", 0); RETURN_INT(0);
#ifdef _WIN32 #ifdef _WIN32
DWORD bytes_read = 0; DWORD bytes_read = 0;
@ -909,7 +909,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
RETURN_FAIL("WaitCommEvent() failed"); RETURN_FAIL("WaitCommEvent() failed");
} }
RETURN_VALUE("%d", bytes_read); RETURN_INT(bytes_read);
#else #else
size_t bytes_read = 0; size_t bytes_read = 0;
@ -938,7 +938,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
gettimeofday(&now, NULL); gettimeofday(&now, NULL);
if (timercmp(&now, &end, >)) if (timercmp(&now, &end, >))
/* Timeout has expired. */ /* Timeout has expired. */
RETURN_VALUE("%d", bytes_read); RETURN_INT(bytes_read);
timersub(&end, &now, &delta); timersub(&end, &now, &delta);
} }
result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL); result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL);
@ -951,7 +951,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
} }
} else if (result == 0) { } else if (result == 0) {
DEBUG("read timed out"); DEBUG("read timed out");
RETURN_VALUE("%d", bytes_read); RETURN_INT(bytes_read);
} }
/* Do read. */ /* Do read. */
@ -970,7 +970,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
ptr += result; ptr += result;
} }
RETURN_VALUE("%d", bytes_read); RETURN_INT(bytes_read);
#endif #endif
} }
@ -1011,7 +1011,7 @@ SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
} }
} }
RETURN_VALUE("%d", bytes_read); RETURN_INT(bytes_read);
#else #else
ssize_t bytes_read; ssize_t bytes_read;
@ -1024,7 +1024,7 @@ SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
/* This is an actual failure. */ /* This is an actual failure. */
RETURN_FAIL("read() failed"); RETURN_FAIL("read() failed");
} }
RETURN_VALUE("%d", bytes_read); RETURN_INT(bytes_read);
#endif #endif
} }
@ -1042,12 +1042,12 @@ SP_API enum sp_return sp_input_waiting(struct sp_port *port)
if (ClearCommError(port->hdl, &errors, &comstat) == 0) if (ClearCommError(port->hdl, &errors, &comstat) == 0)
RETURN_FAIL("ClearCommError() failed"); RETURN_FAIL("ClearCommError() failed");
RETURN_VALUE("%d", comstat.cbInQue); RETURN_INT(comstat.cbInQue);
#else #else
int bytes_waiting; int bytes_waiting;
if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0) if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
RETURN_FAIL("TIOCINQ ioctl failed"); RETURN_FAIL("TIOCINQ ioctl failed");
RETURN_VALUE("%d", bytes_waiting); RETURN_INT(bytes_waiting);
#endif #endif
} }
@ -1065,12 +1065,12 @@ SP_API enum sp_return sp_output_waiting(struct sp_port *port)
if (ClearCommError(port->hdl, &errors, &comstat) == 0) if (ClearCommError(port->hdl, &errors, &comstat) == 0)
RETURN_FAIL("ClearCommError() failed"); RETURN_FAIL("ClearCommError() failed");
RETURN_VALUE("%d", comstat.cbOutQue); RETURN_INT(comstat.cbOutQue);
#else #else
int bytes_waiting; int bytes_waiting;
if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0) if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
RETURN_FAIL("TIOCOUTQ ioctl failed"); RETURN_FAIL("TIOCOUTQ ioctl failed");
RETURN_VALUE("%d", bytes_waiting); RETURN_INT(bytes_waiting);
#endif #endif
} }
@ -2208,9 +2208,9 @@ SP_API int sp_last_error_code(void)
{ {
TRACE(""); TRACE("");
#ifdef _WIN32 #ifdef _WIN32
RETURN_VALUE("%d", GetLastError()); RETURN_INT(GetLastError());
#else #else
RETURN_VALUE("%d", errno); RETURN_INT(errno);
#endif #endif
} }
@ -2232,9 +2232,9 @@ SP_API char *sp_last_error_message(void)
(LPTSTR) &message, (LPTSTR) &message,
0, NULL ); 0, NULL );
RETURN_VALUE("%s", message); RETURN_STRING(message);
#else #else
RETURN_VALUE("%s", strerror(errno)); RETURN_STRING(strerror(errno));
#endif #endif
} }