Files
bacnet_stack/src/bacnet/arf.h
T
Kari Argillander a2f1d6959d Make most of functions const correct (#714)
* 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>
2024-08-29 14:08:02 -05:00

108 lines
2.9 KiB
C

/**
* @file
* @brief BACnet AtomicReadFile service structures, codecs, and handlers.
* @author Steve Karg <skarg@users.sourceforge.net>
* @date 2007
* @copyright SPDX-License-Identifier: MIT
*/
#ifndef BACNET_ATOMIC_READ_FILE_H
#define BACNET_ATOMIC_READ_FILE_H
#include <stdint.h>
#include <stdbool.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacdcode.h"
#include "bacnet/bacstr.h"
#ifndef BACNET_READ_FILE_RECORD_COUNT
#define BACNET_READ_FILE_RECORD_COUNT 1
#endif
typedef struct BACnet_Atomic_Read_File_Data {
/* number type first to avoid enum cast warning on = { 0 } */
uint32_t object_instance;
BACNET_OBJECT_TYPE object_type;
BACNET_FILE_ACCESS_METHOD access;
union {
struct {
int32_t fileStartPosition;
BACNET_UNSIGNED_INTEGER requestedOctetCount;
} stream;
struct {
int32_t fileStartRecord;
/* requested or returned record count */
BACNET_UNSIGNED_INTEGER RecordCount;
} record;
} type;
BACNET_OCTET_STRING fileData[BACNET_READ_FILE_RECORD_COUNT];
bool endOfFile;
} BACNET_ATOMIC_READ_FILE_DATA;
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* Atomic Read File */
/* encode service */
BACNET_STACK_EXPORT
int arf_encode_apdu(
uint8_t * apdu,
uint8_t invoke_id,
const BACNET_ATOMIC_READ_FILE_DATA * data);
BACNET_STACK_EXPORT
int arf_service_encode_apdu(
uint8_t *apdu,
const BACNET_ATOMIC_READ_FILE_DATA *data);
BACNET_STACK_EXPORT
size_t atomicreadfile_service_request_encode(
uint8_t *apdu,
size_t apdu_size,
const BACNET_ATOMIC_READ_FILE_DATA *data);
/* decode the service request only */
BACNET_STACK_EXPORT
int arf_decode_service_request(
const uint8_t * apdu,
unsigned apdu_len,
BACNET_ATOMIC_READ_FILE_DATA * data);
BACNET_STACK_EXPORT
int arf_decode_apdu(
const uint8_t * apdu,
unsigned apdu_len,
uint8_t * invoke_id,
BACNET_ATOMIC_READ_FILE_DATA * data);
/* Atomic Read File Ack */
/* encode service */
BACNET_STACK_EXPORT
int arf_ack_encode_apdu(
uint8_t * apdu,
uint8_t invoke_id,
const BACNET_ATOMIC_READ_FILE_DATA * data);
BACNET_STACK_EXPORT
int arf_ack_service_encode_apdu(
uint8_t *apdu,
const BACNET_ATOMIC_READ_FILE_DATA *data);
/* decode the service request only */
BACNET_STACK_EXPORT
int arf_ack_decode_service_request(
const uint8_t * apdu,
unsigned apdu_len,
BACNET_ATOMIC_READ_FILE_DATA * data);
BACNET_STACK_EXPORT
int arf_ack_decode_apdu(
const uint8_t * apdu,
unsigned apdu_len,
uint8_t * invoke_id,
BACNET_ATOMIC_READ_FILE_DATA * data);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif