Loading...
Searching...
No Matches
sexp-manip.h
Go to the documentation of this file.
/*
* Copyright 2009 Red Hat Inc., Durham, North Carolina.
* All Rights Reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Authors:
* Daniel Kopecek <dkopecek@redhat.com>
*/
#pragma once
#ifndef SEXP_MANIP_H
#define SEXP_MANIP_H
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <sexp-types.h>
#include <helpers.h>
#include "oscap_export.h"
#include <common/util.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* number
*/
OSCAP_API SEXP_t *SEXP_number_new (SEXP_numtype_t t, const void *n) __attribute__ ((nonnull (2)));
OSCAP_API SEXP_t *SEXP_number_newb (bool n);
OSCAP_API SEXP_t *SEXP_number_newi_8 (int8_t n);
OSCAP_API SEXP_t *SEXP_number_newu_8 (uint8_t n);
OSCAP_API uint8_t SEXP_number_getu_8 (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_number_newi_16 (int16_t n);
OSCAP_API SEXP_t *SEXP_number_newu_16 (uint16_t n);
#define SEXP_number_newi SEXP_number_newi_32
OSCAP_API SEXP_t *SEXP_number_newi_32 (int32_t n);
#define SEXP_number_geti SEXP_number_geti_32
OSCAP_API int32_t SEXP_number_geti_32 (const SEXP_t *s_exp);
OSCAP_API bool SEXP_number_getb (const SEXP_t *s_exp);
#define SEXP_number_newu SEXP_number_newu_32
OSCAP_API SEXP_t *SEXP_number_newu_32 (uint32_t n);
#define SEXP_number_getu SEXP_number_getu_32
OSCAP_API uint32_t SEXP_number_getu_32 (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_number_newi_64 (int64_t n);
OSCAP_API int64_t SEXP_number_geti_64 (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_number_newu_64 (uint64_t n);
OSCAP_API uint64_t SEXP_number_getu_64 (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_number_newf (double n);
OSCAP_API double SEXP_number_getf (const SEXP_t *s_exp);
OSCAP_API int SEXP_number_get (const SEXP_t *s_exp, void *dst, SEXP_numtype_t type);
OSCAP_API uint16_t SEXP_number_getu_16 (const SEXP_t *s_exp);
OSCAP_API void SEXP_number_free (SEXP_t *s_exp);
OSCAP_API bool SEXP_numberp (const SEXP_t *s_exp);
OSCAP_API SEXP_numtype_t SEXP_number_type (const SEXP_t *sexp);
/*
* string
*/
OSCAP_API SEXP_t *SEXP_string_new (const void *string, size_t strlen) __attribute__ ((nonnull (1)));
OSCAP_API SEXP_t *SEXP_string_newf (const char *format, ...) __attribute__ ((format (printf, 1, 2), nonnull (1)));
OSCAP_API void SEXP_string_free (SEXP_t *s_exp);
OSCAP_API bool SEXP_stringp (const SEXP_t *s_exp);
OSCAP_API size_t SEXP_string_length (const SEXP_t *s_exp);
OSCAP_API int SEXP_strcmp (const SEXP_t *s_exp, const char *str) __attribute__ ((nonnull (2)));
OSCAP_API int SEXP_strncmp (const SEXP_t *s_exp, const char *str, size_t n) __attribute__ ((nonnull (2)));
OSCAP_API int SEXP_string_nth (const SEXP_t *s_exp, size_t n);
OSCAP_API char *SEXP_string_cstr (const SEXP_t *s_exp);
OSCAP_API size_t SEXP_string_cstr_r (const SEXP_t *s_exp, char *buf, size_t len) __attribute__ ((nonnull (2)));
OSCAP_API char *SEXP_string_cstrp (const SEXP_t *s_exp);
OSCAP_API char *SEXP_string_subcstr (const SEXP_t *s_exp, size_t beg, size_t len);
OSCAP_API int SEXP_string_cmp (const SEXP_t *str_a, const SEXP_t *str_b);
OSCAP_API bool SEXP_string_getb (const SEXP_t *s_exp);
/*
* list
*/
OSCAP_API SEXP_t *SEXP_list_new (SEXP_t *memb, ...);
OSCAP_API void SEXP_list_free (SEXP_t *s_exp);
OSCAP_API bool SEXP_listp (const SEXP_t *s_exp);
OSCAP_API size_t SEXP_list_length (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_list_first (const SEXP_t *list);
OSCAP_API SEXP_t *SEXP_list_rest (const SEXP_t *list);
OSCAP_API SEXP_t *SEXP_list_last (const SEXP_t *list);
OSCAP_API SEXP_t *SEXP_list_nth (const SEXP_t *list, uint32_t n);
OSCAP_API SEXP_t *SEXP_list_add (SEXP_t *list, const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_list_join (const SEXP_t *list_a, const SEXP_t *list_b);
OSCAP_API SEXP_t *SEXP_list_push (SEXP_t *list, const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_list_pop (SEXP_t *list);
OSCAP_API SEXP_t *SEXP_list_sort(SEXP_t *list, int(*compare)(const SEXP_t *, const SEXP_t *));
OSCAP_API SEXP_t *SEXP_list_replace (SEXP_t *list, uint32_t n, const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_listref_first (SEXP_t *list);
OSCAP_API SEXP_t *SEXP_listref_rest (SEXP_t *list);
OSCAP_API SEXP_t *SEXP_listref_last (SEXP_t *list);
OSCAP_API SEXP_t *SEXP_listref_nth (SEXP_t *list, uint32_t n);
typedef struct SEXP_it SEXP_it_t;
#define SEXP_IT_RECURSIVE 0x01
#define SEXP_IT_HARDREF 0x02
typedef struct SEXP_list_it SEXP_list_it;
OSCAP_API SEXP_list_it *SEXP_list_it_new(const SEXP_t *list);
OSCAP_API SEXP_t *SEXP_list_it_next(SEXP_list_it *it);
OSCAP_API void SEXP_list_it_free(SEXP_list_it *it);
/* TODO: use alloca & softref_r here */
#define SEXP_list_foreach(var, list) \
for (uint32_t OSCAP_CONCAT(i,__LINE__) = 1; ((var) = SEXP_list_nth (list, OSCAP_CONCAT(i,__LINE__))) != NULL; ++OSCAP_CONCAT(i,__LINE__), SEXP_free (var), (var) = NULL)
#define SEXP_sublist_foreach(var, list, beg, end) \
for (uint32_t OSCAP_CONCAT(i,__LINE__) = (beg); OSCAP_CONCAT(i,__LINE__) <= ((size_t)(end)) && ((var) = SEXP_list_nth (list, OSCAP_CONCAT(i,__LINE__))) != NULL; ++OSCAP_CONCAT(i,__LINE__), SEXP_free (var), (var) = NULL)
#define SEXP_LIST_END (UINT32_MAX - 1)
/*
* generic
*/
OSCAP_API SEXP_t *SEXP_new (void);
OSCAP_API bool SEXP_emptyp(SEXP_t *sexp);
OSCAP_API SEXP_t *SEXP_ref (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_unref (SEXP_t *s_exp_o);
OSCAP_API SEXP_t *SEXP_softref (SEXP_t *s_exp);
OSCAP_API bool SEXP_softrefp(const SEXP_t *s_exp);
OSCAP_API uint32_t SEXP_refs (const SEXP_t *ref);
OSCAP_API bool SEXP_eq (const SEXP_t *a, const SEXP_t *b);
OSCAP_API int SEXP_refcmp(const SEXP_t *a, const SEXP_t *b);
OSCAP_API bool SEXP_deepcmp(const SEXP_t *a, const SEXP_t *b);
OSCAP_API void SEXP_free (SEXP_t *s_exp);
OSCAP_API const char *SEXP_datatype (const SEXP_t *s_exp);
OSCAP_API int SEXP_datatype_set (SEXP_t *s_exp, const char *name) __attribute__ ((nonnull (2)));
OSCAP_API int SEXP_datatype_set_nth (SEXP_t *list, uint32_t n, const char *name) __attribute__ ((nonnull (3)));
OSCAP_API SEXP_type_t SEXP_typeof (const SEXP_t *s_exp);
OSCAP_API const char *SEXP_strtype (const SEXP_t *s_exp);
OSCAP_API SEXP_t *SEXP_build (const char *s_str, ...);
OSCAP_API size_t SEXP_sizeof (const SEXP_t *s_exp);
#if !defined(NDEBUG)
# define SEXP_VALIDATE(s) __SEXP_VALIDATE(s, __FILE__, __LINE__, __PRETTY_FUNCTION__)
# include <stdlib.h>
OSCAP_API void __SEXP_VALIDATE(const SEXP_t *s_exp, const char *file, uint32_t line, const char *func);
#else
# define SEXP_VALIDATE(s)
#endif
#ifdef __cplusplus
}
#endif
#endif /* SEXP_MANIP_H */
SEXP_number_newf
OSCAP_API SEXP_t * SEXP_number_newf(double n)
Create a new sexp object from an floating point value.
Definition sexp-manip.c:516
SEXP_list_length
OSCAP_API size_t SEXP_list_length(const SEXP_t *s_exp)
Get the length of the sexp list.
Definition sexp-manip.c:960
SEXP_listp
OSCAP_API bool SEXP_listp(const SEXP_t *s_exp)
Check whether the provided sexp object is a list.
Definition sexp-manip.c:948
SEXP_list_free
OSCAP_API void SEXP_list_free(SEXP_t *s_exp)
Free the specified sexp object.
Definition sexp-manip.c:942
SEXP_list_first
OSCAP_API SEXP_t * SEXP_list_first(const SEXP_t *list)
Get the first element of a list.
Definition sexp-manip.c:981
SEXP_number_free
OSCAP_API void SEXP_number_free(SEXP_t *s_exp)
Free the specified sexp object.
Definition sexp-manip.c:556
SEXP_string_length
OSCAP_API size_t SEXP_string_length(const SEXP_t *s_exp)
Get the length of a string in a sexp object.
Definition sexp-manip.c:641
SEXP_softref
OSCAP_API SEXP_t * SEXP_softref(SEXP_t *s_exp)
Create a new soft reference to a sexp object.
Definition sexp-manip.c:1587
SEXP_listref_nth
OSCAP_API SEXP_t * SEXP_listref_nth(SEXP_t *list, uint32_t n)
Get the n-th element of a list.
Definition sexp-manip.c:1155
SEXP_number_new
OSCAP_API SEXP_t * SEXP_number_new(SEXP_numtype_t t, const void *n) __attribute__((nonnull(2)))
Create a new sexp object from a value and a number type.
Definition sexp-manip.c:56
SEXP_number_getu_64
OSCAP_API uint64_t SEXP_number_getu_64(const SEXP_t *s_exp)
Get unsigned integer value from a sexp object.
Definition sexp-manip.c:430
SEXP_string_cstr
OSCAP_API char * SEXP_string_cstr(const SEXP_t *s_exp)
Get a C string from a sexp object.
Definition sexp-manip.c:755
SEXP_number_newb
OSCAP_API SEXP_t * SEXP_number_newb(bool n)
Create a new sexp object from a boolean value.
Definition sexp-manip.c:91
SEXP_number_getf
OSCAP_API double SEXP_number_getf(const SEXP_t *s_exp)
Get floating point value from a sexp object.
Definition sexp-manip.c:526
SEXP_refcmp
OSCAP_API int SEXP_refcmp(const SEXP_t *a, const SEXP_t *b)
Compare reference pointers.
Definition sexp-manip.c:1651
SEXP_listref_first
OSCAP_API SEXP_t * SEXP_listref_first(SEXP_t *list)
Get the first element of a list.
Definition sexp-manip.c:1006
SEXP_number_newi_8
OSCAP_API SEXP_t * SEXP_number_newi_8(int8_t n)
Create a new sexp object from an integer.
Definition sexp-manip.c:101
SEXP_list_new
OSCAP_API SEXP_t * SEXP_list_new(SEXP_t *memb,...)
Create a new sexp list, optionally initialized with the provided sexp arguments.
Definition sexp-manip.c:926
SEXP_string_subcstr
OSCAP_API char * SEXP_string_subcstr(const SEXP_t *s_exp, size_t beg, size_t len)
Get a C substring from a sexp object.
Definition sexp-manip.c:814
SEXP_number_getu_16
OSCAP_API uint16_t SEXP_number_getu_16(const SEXP_t *s_exp)
Get unsigned integer value from a sexp object.
Definition sexp-manip.c:221
SEXP_string_cmp
OSCAP_API int SEXP_string_cmp(const SEXP_t *str_a, const SEXP_t *str_b)
Compare two sexp strings.
Definition sexp-manip.c:872
SEXP_string_free
OSCAP_API void SEXP_string_free(SEXP_t *s_exp)
Free the specified sexp object.
Definition sexp-manip.c:623
SEXP_refs
OSCAP_API uint32_t SEXP_refs(const SEXP_t *ref)
Return the value of the reference counter.
Definition sexp-manip.c:1627
SEXP_number_newu_8
OSCAP_API SEXP_t * SEXP_number_newu_8(uint8_t n)
Create a new sexp object from an unsigned integer.
Definition sexp-manip.c:123
SEXP_ref
OSCAP_API SEXP_t * SEXP_ref(const SEXP_t *s_exp)
Create a new reference to a sexp object.
Definition sexp-manip.c:1527
SEXP_list_nth
OSCAP_API SEXP_t * SEXP_list_nth(const SEXP_t *list, uint32_t n)
Get the n-th element of a list.
Definition sexp-manip.c:1126
SEXP_number_type
OSCAP_API SEXP_numtype_t SEXP_number_type(const SEXP_t *sexp)
Get the number type of an object.
Definition sexp-manip.c:575
SEXP_strcmp
OSCAP_API int SEXP_strcmp(const SEXP_t *s_exp, const char *str) __attribute__((nonnull(2)))
Compare a string in a sexp object with a C string.
Definition sexp-manip.c:662
SEXP_number_newi_32
OSCAP_API SEXP_t * SEXP_number_newi_32(int32_t n)
Create a new sexp object from an integer.
Definition sexp-manip.c:256
SEXP_datatype
OSCAP_API const char * SEXP_datatype(const SEXP_t *s_exp)
Get the user data type of a sexp object.
Definition sexp-manip.c:1786
SEXP_numberp
OSCAP_API bool SEXP_numberp(const SEXP_t *s_exp)
Check whether the provided sexp object is a number.
Definition sexp-manip.c:562
SEXP_datatype_set_nth
OSCAP_API int SEXP_datatype_set_nth(SEXP_t *list, uint32_t n, const char *name) __attribute__((nonnull(3)))
Set the user data type of the nth sexp object in a list.
Definition sexp-manip.c:1829
SEXP_number_geti_32
OSCAP_API int32_t SEXP_number_geti_32(const SEXP_t *s_exp)
Get integer value from a sexp object.
Definition sexp-manip.c:266
SEXP_strtype
OSCAP_API const char * SEXP_strtype(const SEXP_t *s_exp)
Get a text description of the sexp object's type.
Definition sexp-manip.c:1886
SEXP_list_last
OSCAP_API SEXP_t * SEXP_list_last(const SEXP_t *list)
Get the last element of a list.
Definition sexp-manip.c:1053
SEXP_list_add
OSCAP_API SEXP_t * SEXP_list_add(SEXP_t *list, const SEXP_t *s_exp)
Add an element to a list.
Definition sexp-manip.c:1185
SEXP_string_cstrp
OSCAP_API char * SEXP_string_cstrp(const SEXP_t *s_exp)
Obsolete function.
Definition sexp-manip.c:860
SEXP_string_newf
OSCAP_API SEXP_t * SEXP_string_newf(const char *format,...) __attribute__((format(printf
Create a new sexp object from a format string.
Definition sexp-manip.c:610
SEXP_number_get
OSCAP_API int SEXP_number_get(const SEXP_t *s_exp, void *dst, SEXP_numtype_t type)
Get a value from a sexp object according to a specified type.
Definition sexp-manip.c:549
SEXP_list_pop
OSCAP_API SEXP_t * SEXP_list_pop(SEXP_t *list)
Extract the first element of a list.
Definition sexp-manip.c:1271
SEXP_datatype_set
OSCAP_API int SEXP_datatype_set(SEXP_t *s_exp, const char *name) __attribute__((nonnull(2)))
Set the user data type of a sexp object.
Definition sexp-manip.c:1802
SEXP_string_cstr_r
OSCAP_API size_t SEXP_string_cstr_r(const SEXP_t *s_exp, char *buf, size_t len) __attribute__((nonnull(2)))
Get a C string from a sexp object.
Definition sexp-manip.c:785
SEXP_string_new
OSCAP_API SEXP_t * SEXP_string_new(const void *string, size_t strlen) __attribute__((nonnull(1)))
Create a new sexp object from a string.
Definition sexp-manip.c:600
SEXP_list_join
OSCAP_API SEXP_t * SEXP_list_join(const SEXP_t *list_a, const SEXP_t *list_b)
Create a new list containing the concatenated contents of two lists.
Definition sexp-manip.c:1237
SEXP_typeof
OSCAP_API SEXP_type_t SEXP_typeof(const SEXP_t *s_exp)
Get the type of a sexp object.
Definition sexp-manip.c:1869
SEXP_number_getu_32
OSCAP_API uint32_t SEXP_number_getu_32(const SEXP_t *s_exp)
Get unsigned integer value from a sexp object.
Definition sexp-manip.c:315
SEXP_softrefp
OSCAP_API bool SEXP_softrefp(const SEXP_t *s_exp)
Check whether an S-exp reference is a "soft" reference.
Definition sexp-manip.c:1617
SEXP_number_getb
OSCAP_API bool SEXP_number_getb(const SEXP_t *s_exp)
Get boolean value from a sexp object.
Definition sexp-manip.c:473
SEXP_list_push
OSCAP_API SEXP_t * SEXP_list_push(SEXP_t *list, const SEXP_t *s_exp)
Push an element to the head of a list.
Definition sexp-manip.c:1263
SEXP_number_getu_8
OSCAP_API uint8_t SEXP_number_getu_8(const SEXP_t *s_exp)
Get unsigned integer value from a sexp object.
Definition sexp-manip.c:145
SEXP_string_nth
OSCAP_API int SEXP_string_nth(const SEXP_t *s_exp, size_t n)
Get the n-th byte of a string.
Definition sexp-manip.c:729
SEXP_list_replace
OSCAP_API SEXP_t * SEXP_list_replace(SEXP_t *list, uint32_t n, const SEXP_t *s_exp)
Sort a list using `compare' as the comparison function.
Definition sexp-manip.c:1080
SEXP_number_newi_16
OSCAP_API SEXP_t * SEXP_number_newi_16(int16_t n)
Create a new sexp object from an integer.
Definition sexp-manip.c:177
SEXP_number_newu_32
OSCAP_API SEXP_t * SEXP_number_newu_32(uint32_t n)
Create a new sexp object from an unsigned integer.
Definition sexp-manip.c:305
SEXP_list_rest
OSCAP_API SEXP_t * SEXP_list_rest(const SEXP_t *list)
Get the rest of a list.
Definition sexp-manip.c:1034
SEXP_number_newi_64
OSCAP_API SEXP_t * SEXP_number_newi_64(int64_t n)
Create a new sexp object from an integer.
Definition sexp-manip.c:354
SEXP_string_getb
OSCAP_API bool SEXP_string_getb(const SEXP_t *s_exp)
Try to cast the supplied sexp string to a boolean.
Definition sexp-manip.c:896
SEXP_listref_rest
OSCAP_API SEXP_t * SEXP_listref_rest(SEXP_t *list)
Get the rest of a list.
Definition sexp-manip.c:1047
SEXP_strncmp
OSCAP_API int SEXP_strncmp(const SEXP_t *s_exp, const char *str, size_t n) __attribute__((nonnull(2)))
Compare a string in a sexp object with a C string.
Definition sexp-manip.c:695
SEXP_listref_last
OSCAP_API SEXP_t * SEXP_listref_last(SEXP_t *list)
Get the last element of a list.
Definition sexp-manip.c:1120
SEXP_number_geti_64
OSCAP_API int64_t SEXP_number_geti_64(const SEXP_t *s_exp)
Get integer value from a sexp object.
Definition sexp-manip.c:376
SEXP_number_newu_64
OSCAP_API SEXP_t * SEXP_number_newu_64(uint64_t n)
Create a new sexp object from an unsigned integer.
Definition sexp-manip.c:420
SEXP_number_newu_16
OSCAP_API SEXP_t * SEXP_number_newu_16(uint16_t n)
Create a new sexp object from an unsigned integer.
Definition sexp-manip.c:199
SEXP_stringp
OSCAP_API bool SEXP_stringp(const SEXP_t *s_exp)
Check whether the provided sexp object is a string.
Definition sexp-manip.c:629
SEXP_free
OSCAP_API void SEXP_free(SEXP_t *s_exp)
Free a sexp object.
Definition sexp-manip.c:1777
SEXP_list_it
Definition sexp-manip.c:1318