Kari Argillander
a2f1d6959d
* Make most of the functions const correct
Used clang-tidy and sonarlint to help find places where const could
pretty easily applied. Also lot of hand work.
This commit does not yet touch handlers and typedefs of those.
* Fix Arduino uno handler_who_is() has extra parenthesis
For some reason there is extra parenthesis. Remove it this is more
likely buildable.
* Bugfix/bacapp: Fix uninitilized array_index
We have changed bacapp_snprintf_value() to be const correct. After that
we got
```
/home/runner/work/bacnet-stack/bacnet-stack/src/bacnet/bacapp.c:3183:27: warning: 4th function call argument is an uninitialized value [core.CallAndMessage]
ret_val = bacapp_snprintf_weeklyschedule(
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
```
So analyzer could now spot that we do not actually initilize array_index
at all. Fix this by setting array_index to zero. Note that I actually do
not know if zeroing is right thing to do here. I choose zero as if this
has worked before it is most likely that it will work with zero value.
* cmake: Add and ignore Wwrite-strings compiler option
Wwrite-strings helps find places where const correctness is broken.
Example it will warn about these
```C
void func1(char* str);
func("test") /* "test" is const so we should not pass it to func1().
char* func2()
{
return "test"; /* func2() should return const char*.
}
```
We still need to ignore it as not all are fixed but let's add it already
so we remember that it should be opened at some point.
---------
Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
113 lines
3.1 KiB
C
113 lines
3.1 KiB
C
/**
|
|
* @file
|
|
* @brief API for BACnetActionCommand codec used by Command objects
|
|
* @author Steve Karg <skarg@users.sourceforge.net>
|
|
* @date 2024
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_ACTION_H
|
|
#define BACNET_ACTION_H
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
#include "bacnet/bactimevalue.h"
|
|
|
|
/* BACNET_ACTION_VALUE encodes and decodes the Property Value
|
|
in the Action Command. Choose the datatypes that your
|
|
application supports, or add additional. */
|
|
#if !( \
|
|
defined(BACACTION_ALL) || defined(BACACTION_NULL) || \
|
|
defined(BACACTION_BOOLEAN) || defined(BACACTION_UNSIGNED) || \
|
|
defined(BACACTION_SIGNED) || defined(BACACTION_REAL) || \
|
|
defined(BACACTION_DOUBLE) || defined(BACACTION_OCTET_STRING) || \
|
|
defined(BACACTION_ENUMERATED))
|
|
#define BACACTION_ALL
|
|
#endif
|
|
|
|
#if defined(BACACTION_ALL)
|
|
#define BACACTION_NULL
|
|
#define BACACTION_BOOLEAN
|
|
#define BACACTION_UNSIGNED
|
|
#define BACACTION_SIGNED
|
|
#define BACACTION_REAL
|
|
#define BACACTION_DOUBLE
|
|
#define BACACTION_ENUMERATED
|
|
#endif
|
|
|
|
typedef struct BACnetActionPropertyValue {
|
|
uint8_t tag;
|
|
union {
|
|
#if defined(BACACTION_NULL)
|
|
/* NULL - not needed because it is encoded in the tag alone */
|
|
#endif
|
|
#if defined(BACACTION_BOOLEAN)
|
|
bool Boolean;
|
|
#endif
|
|
#if defined(BACACTION_UNSIGNED)
|
|
BACNET_UNSIGNED_INTEGER Unsigned_Int;
|
|
#endif
|
|
#if defined(BACACTION_SIGNED)
|
|
int32_t Signed_Int;
|
|
#endif
|
|
#if defined(BACACTION_REAL)
|
|
float Real;
|
|
#endif
|
|
#if defined(BACACTION_DOUBLE)
|
|
double Double;
|
|
#endif
|
|
#if defined(BACACTION_ENUMERATED)
|
|
uint32_t Enumerated;
|
|
#endif
|
|
} type;
|
|
/* simple linked list if needed */
|
|
struct BACnetActionPropertyValue *next;
|
|
} BACNET_ACTION_PROPERTY_VALUE;
|
|
|
|
typedef struct bacnet_action_list {
|
|
BACNET_OBJECT_ID Device_Id; /* Optional */
|
|
BACNET_OBJECT_ID Object_Id;
|
|
BACNET_PROPERTY_ID Property_Identifier;
|
|
uint32_t Property_Array_Index; /* Conditional */
|
|
BACNET_ACTION_PROPERTY_VALUE Value;
|
|
uint8_t Priority; /* Conditional */
|
|
uint32_t Post_Delay; /* Optional */
|
|
bool Quit_On_Failure;
|
|
bool Write_Successful;
|
|
struct bacnet_action_list *next;
|
|
} BACNET_ACTION_LIST;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
BACNET_STACK_EXPORT
|
|
int bacnet_action_property_value_encode(
|
|
uint8_t *apdu, const BACNET_ACTION_PROPERTY_VALUE *value);
|
|
BACNET_STACK_EXPORT
|
|
int bacnet_action_property_value_decode(
|
|
const uint8_t *apdu,
|
|
uint32_t apdu_size,
|
|
BACNET_ACTION_PROPERTY_VALUE *value);
|
|
BACNET_STACK_EXPORT
|
|
bool bacnet_action_property_value_same(
|
|
const BACNET_ACTION_PROPERTY_VALUE *value1,
|
|
const BACNET_ACTION_PROPERTY_VALUE *value2);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int bacnet_action_command_encode(
|
|
uint8_t *apdu, const BACNET_ACTION_LIST *entry);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int bacnet_action_command_decode(
|
|
const uint8_t *apdu, size_t apdu_size, BACNET_ACTION_LIST *entry);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacnet_action_command_same(
|
|
const BACNET_ACTION_LIST *entry1, const BACNET_ACTION_LIST *entry2);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|