dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make most of functions const correct (#714)

Browse Source 
* 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>
This commit is contained in:
Kari Argillander
2024-08-29 22:08:02 +03:00
committed by GitHub
parent 0177c59f4a
commit a2f1d6959d
408 changed files with 2608 additions and 2336 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/bacnet/bacstr.h
+28 -28
View File
@@ -46,22 +46,22 @@ extern "C" {
bool value);
BACNET_STACK_EXPORT
bool bitstring_bit(
BACNET_BIT_STRING * bit_string,
const BACNET_BIT_STRING * bit_string,
uint8_t bit_number);
BACNET_STACK_EXPORT
uint8_t bitstring_bits_used(
BACNET_BIT_STRING * bit_string);
const BACNET_BIT_STRING * bit_string);
/* returns the number of bytes that a bit string is using */
BACNET_STACK_EXPORT
uint8_t bitstring_bytes_used(
BACNET_BIT_STRING * bit_string);
const BACNET_BIT_STRING * bit_string);
BACNET_STACK_EXPORT
unsigned bitstring_bits_capacity(
BACNET_BIT_STRING * bit_string);
const BACNET_BIT_STRING * bit_string);
/* used for encoding and decoding from the APDU */
BACNET_STACK_EXPORT
uint8_t bitstring_octet(
BACNET_BIT_STRING * bit_string,
const BACNET_BIT_STRING * bit_string,
uint8_t octet_index);
BACNET_STACK_EXPORT
bool bitstring_set_octet(
@@ -76,11 +76,11 @@ extern "C" {
BACNET_STACK_EXPORT
bool bitstring_copy(
BACNET_BIT_STRING * dest,
BACNET_BIT_STRING * src);
const BACNET_BIT_STRING * src);
BACNET_STACK_EXPORT
bool bitstring_same(
BACNET_BIT_STRING * bitstring1,
BACNET_BIT_STRING * bitstring2);
const BACNET_BIT_STRING * bitstring1,
const BACNET_BIT_STRING * bitstring2);
BACNET_STACK_EXPORT
bool bitstring_init_ascii(
BACNET_BIT_STRING * bit_string,
@@ -111,20 +111,20 @@ extern "C" {
BACNET_STACK_EXPORT
bool characterstring_copy(
BACNET_CHARACTER_STRING * dest,
BACNET_CHARACTER_STRING * src);
const BACNET_CHARACTER_STRING * src);
BACNET_STACK_EXPORT
bool characterstring_ansi_copy(
char *dest,
size_t dest_max_len,
BACNET_CHARACTER_STRING * src);
const BACNET_CHARACTER_STRING * src);
/* returns true if the strings are the same length, encoding, value */
BACNET_STACK_EXPORT
bool characterstring_same(
BACNET_CHARACTER_STRING * dest,
BACNET_CHARACTER_STRING * src);
const BACNET_CHARACTER_STRING * dest,
const BACNET_CHARACTER_STRING * src);
BACNET_STACK_EXPORT
bool characterstring_ansi_same(
BACNET_CHARACTER_STRING * dest,
const BACNET_CHARACTER_STRING * dest,
const char *src);
/* returns false if the string exceeds capacity */
BACNET_STACK_EXPORT
@@ -145,24 +145,24 @@ extern "C" {
uint8_t encoding);
/* Returns the value */
BACNET_STACK_EXPORT
char *characterstring_value(
BACNET_CHARACTER_STRING * char_string);
const char *characterstring_value(
const BACNET_CHARACTER_STRING * char_string);
/* returns the length */
BACNET_STACK_EXPORT
size_t characterstring_length(
BACNET_CHARACTER_STRING * char_string);
const BACNET_CHARACTER_STRING * char_string);
BACNET_STACK_EXPORT
uint8_t characterstring_encoding(
BACNET_CHARACTER_STRING * char_string);
const BACNET_CHARACTER_STRING * char_string);
BACNET_STACK_EXPORT
size_t characterstring_capacity(
BACNET_CHARACTER_STRING * char_string);
const BACNET_CHARACTER_STRING * char_string);
BACNET_STACK_EXPORT
bool characterstring_printable(
BACNET_CHARACTER_STRING * char_string);
const BACNET_CHARACTER_STRING * char_string);
BACNET_STACK_EXPORT
bool characterstring_valid(
BACNET_CHARACTER_STRING * char_string);
const BACNET_CHARACTER_STRING * char_string);
BACNET_STACK_EXPORT
bool utf8_isvalid(
const char *str,
@@ -173,7 +173,7 @@ extern "C" {
BACNET_STACK_EXPORT
bool octetstring_init(
BACNET_OCTET_STRING * octet_string,
uint8_t * value,
const uint8_t * value,
size_t length);
/* converts an null terminated ASCII Hex string to an octet string.
returns true if successfully converted and fits; false if too long */
@@ -184,17 +184,17 @@ extern "C" {
BACNET_STACK_EXPORT
bool octetstring_copy(
BACNET_OCTET_STRING * dest,
BACNET_OCTET_STRING * src);
const BACNET_OCTET_STRING * src);
BACNET_STACK_EXPORT
size_t octetstring_copy_value(
uint8_t * dest,
size_t length,
BACNET_OCTET_STRING * src);
const BACNET_OCTET_STRING * src);
/* returns false if the string exceeds capacity */
BACNET_STACK_EXPORT
bool octetstring_append(
BACNET_OCTET_STRING * octet_string,
uint8_t * value,
const uint8_t * value,
size_t length);
/* This function sets a new length without changing the value.
If length exceeds capacity, no modification happens and
@@ -210,15 +210,15 @@ extern "C" {
/* Returns the length.*/
BACNET_STACK_EXPORT
size_t octetstring_length(
BACNET_OCTET_STRING * octet_string);
const BACNET_OCTET_STRING * octet_string);
BACNET_STACK_EXPORT
size_t octetstring_capacity(
BACNET_OCTET_STRING * octet_string);
const BACNET_OCTET_STRING * octet_string);
/* returns true if the same length and contents */
BACNET_STACK_EXPORT
bool octetstring_value_same(
BACNET_OCTET_STRING * octet_string1,
BACNET_OCTET_STRING * octet_string2);
const BACNET_OCTET_STRING * octet_string1,
const BACNET_OCTET_STRING * octet_string2);
#ifdef __cplusplus
}