skarg
191 lines
6.4 KiB
C
191 lines
6.4 KiB
C
/*####COPYRIGHTBEGIN####
|
|
-------------------------------------------
|
|
Copyright (C) 2005 Steve Karg
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License
|
|
as published by the Free Software Foundation; either version 2
|
|
of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to:
|
|
The Free Software Foundation, Inc.
|
|
59 Temple Place - Suite 330
|
|
Boston, MA 02111-1307, USA.
|
|
|
|
As a special exception, if other files instantiate templates or
|
|
use macros or inline functions from this file, or you compile
|
|
this file and link it with other works to produce a work based
|
|
on this file, this file does not by itself cause the resulting
|
|
work to be covered by the GNU General Public License. However
|
|
the source code for this file must still be made available in
|
|
accordance with section (3) of the GNU General Public License.
|
|
|
|
This exception does not invalidate any other reasons why a work
|
|
based on this file might be covered by the GNU General Public
|
|
License.
|
|
-------------------------------------------
|
|
####COPYRIGHTEND####*/
|
|
#ifndef BACSTR_H
|
|
#define BACSTR_H
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include "bacdef.h"
|
|
|
|
/* bit strings
|
|
They could be as large as 256/8=32 octets */
|
|
#define MAX_BITSTRING_BYTES 15
|
|
typedef struct BACnet_Bit_String {
|
|
uint8_t bits_used;
|
|
uint8_t value[MAX_BITSTRING_BYTES];
|
|
} BACNET_BIT_STRING;
|
|
|
|
#define MAX_CHARACTER_STRING_BYTES (MAX_APDU-6)
|
|
typedef struct BACnet_Character_String {
|
|
size_t length;
|
|
uint8_t encoding;
|
|
/* limit - 6 octets is the most our tag and type could be */
|
|
char value[MAX_CHARACTER_STRING_BYTES];
|
|
} BACNET_CHARACTER_STRING;
|
|
|
|
/* FIXME: convert the bacdcode library to use BACNET_OCTET_STRING
|
|
for APDU buffer to prevent buffer overflows */
|
|
typedef struct BACnet_Octet_String {
|
|
size_t length;
|
|
/* limit - 6 octets is the most our tag and type could be */
|
|
uint8_t value[MAX_APDU - 6];
|
|
} BACNET_OCTET_STRING;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
void bitstring_init(
|
|
BACNET_BIT_STRING * bit_string);
|
|
void bitstring_set_bit(
|
|
BACNET_BIT_STRING * bit_string,
|
|
uint8_t bit_number,
|
|
bool value);
|
|
bool bitstring_bit(
|
|
BACNET_BIT_STRING * bit_string,
|
|
uint8_t bit_number);
|
|
uint8_t bitstring_bits_used(
|
|
BACNET_BIT_STRING * bit_string);
|
|
/* returns the number of bytes that a bit string is using */
|
|
uint8_t bitstring_bytes_used(
|
|
BACNET_BIT_STRING * bit_string);
|
|
uint8_t bitstring_bits_capacity(
|
|
BACNET_BIT_STRING * bit_string);
|
|
/* used for encoding and decoding from the APDU */
|
|
uint8_t bitstring_octet(
|
|
BACNET_BIT_STRING * bit_string,
|
|
uint8_t octet_index);
|
|
bool bitstring_set_octet(
|
|
BACNET_BIT_STRING * bit_string,
|
|
uint8_t index,
|
|
uint8_t octet);
|
|
bool bitstring_set_bits_used(
|
|
BACNET_BIT_STRING * bit_string,
|
|
uint8_t bytes_used,
|
|
uint8_t unused_bits);
|
|
bool bitstring_copy(
|
|
BACNET_BIT_STRING * dest,
|
|
BACNET_BIT_STRING * src);
|
|
|
|
|
|
/* returns false if the string exceeds capacity
|
|
initialize by using length=0 */
|
|
bool characterstring_init(
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
uint8_t encoding,
|
|
const char *value,
|
|
size_t length);
|
|
/* used for ANSI C-Strings */
|
|
bool characterstring_init_ansi(
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
const char *value);
|
|
bool characterstring_copy(
|
|
BACNET_CHARACTER_STRING * dest,
|
|
BACNET_CHARACTER_STRING * src);
|
|
bool characterstring_ansi_copy(
|
|
char *dest,
|
|
size_t dest_max_len,
|
|
BACNET_CHARACTER_STRING * src);
|
|
/* returns true if the strings are the same length, encoding, value */
|
|
bool characterstring_same(
|
|
BACNET_CHARACTER_STRING * dest,
|
|
BACNET_CHARACTER_STRING * src);
|
|
bool characterstring_ansi_same(
|
|
BACNET_CHARACTER_STRING * dest,
|
|
const char *src);
|
|
/* returns false if the string exceeds capacity */
|
|
bool characterstring_append(
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
const char *value,
|
|
size_t length);
|
|
/* This function sets a new length without changing the value.
|
|
If length exceeds capacity, no modification happens and
|
|
function returns false. */
|
|
bool characterstring_truncate(
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
size_t length);
|
|
bool characterstring_set_encoding(
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
uint8_t encoding);
|
|
/* Returns the value */
|
|
char *characterstring_value(
|
|
BACNET_CHARACTER_STRING * char_string);
|
|
/* returns the length */
|
|
size_t characterstring_length(
|
|
BACNET_CHARACTER_STRING * char_string);
|
|
uint8_t characterstring_encoding(
|
|
BACNET_CHARACTER_STRING * char_string);
|
|
size_t characterstring_capacity(
|
|
BACNET_CHARACTER_STRING * char_string);
|
|
|
|
/* returns false if the string exceeds capacity
|
|
initialize by using length=0 */
|
|
bool octetstring_init(
|
|
BACNET_OCTET_STRING * octet_string,
|
|
uint8_t * value,
|
|
size_t length);
|
|
bool octetstring_copy(
|
|
BACNET_OCTET_STRING * dest,
|
|
BACNET_OCTET_STRING * src);
|
|
/* returns false if the string exceeds capacity */
|
|
bool octetstring_append(
|
|
BACNET_OCTET_STRING * octet_string,
|
|
uint8_t * value,
|
|
size_t length);
|
|
/* This function sets a new length without changing the value.
|
|
If length exceeds capacity, no modification happens and
|
|
function returns false. */
|
|
bool octetstring_truncate(
|
|
BACNET_OCTET_STRING * octet_string,
|
|
size_t length);
|
|
/* Returns the value */
|
|
uint8_t *octetstring_value(
|
|
BACNET_OCTET_STRING * octet_string);
|
|
/* Returns the length.*/
|
|
size_t octetstring_length(
|
|
BACNET_OCTET_STRING * octet_string);
|
|
size_t octetstring_capacity(
|
|
BACNET_OCTET_STRING * octet_string);
|
|
/* returns true if the same length and contents */
|
|
bool octetstring_value_same(
|
|
BACNET_OCTET_STRING * octet_string1,
|
|
BACNET_OCTET_STRING * octet_string2);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|