user_group.h

Go to the documentation of this file.

/*
 * usergroup.h
 *
 *  Created on: 6 Dec 2023
 *      Author: billy
 */
 
#ifndef CORE_SHARED_UTIL_INCLUDE_USER_GROUP_H_
#define CORE_SHARED_UTIL_INCLUDE_USER_GROUP_H_
 
#include "jansson.h"
 
#include "typedefs.h"
#include "grassroots_users_library.h"
#include "linked_list.h"
#include "user_details.h"
 
 
typedef struct UserGroup
{
  char *ug_name_s;
  LinkedList *ug_users_p;
} UserGroup;
 
 
typedef struct UserGroupNode
{
  ListItem ugn_node;
  UserGroup *ugn_group_p;
} UserGroupNode;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
#ifdef ALLOCATE_USER_GROUP_TAGS
  #define USER_GROUP_PREFIX  GRASSROOTS_USERS_API
  #define USER_GROUP_VAL(x) = x
  #define USER_GROUP_CONCAT_VAL(x,y) = x y
#else
  #define USER_GROUP_PREFIX extern GRASSROOTS_USERS_API
  #define USER_GROUP_VAL(x)
  #define USER_GROUP_CONCAT_VAL(x,y)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
USER_GROUP_PREFIX const char * const UG_NAME_S USER_GROUP_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "name");
 
USER_GROUP_PREFIX const char * const UG_USERS_S USER_GROUP_VAL ("users");
 
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_USERS_API UserGroup *AllocateUserGroup (const char *name_s);
 
 
GRASSROOTS_USERS_API void FreeUserGroup (UserGroup *group_p);
 
 
GRASSROOTS_USERS_API json_t *GetUserGroupAsJSON (UserGroup *group_p, const bool full_user_flag);
 
 
 
GRASSROOTS_USERS_API UserGroup *GetUserGroupFromJSON (const json_t *group_json_p);
 
 
GRASSROOTS_USERS_API bool AddUserToGroup (UserGroup *group_p, User *user_p);
 
 
GRASSROOTS_USERS_API bool IsUserInGroup (const UserGroup * const group_p, const User * const user_p);
 
 
GRASSROOTS_USERS_API UserGroupNode *AllocateUserGroupNode (UserGroup *group_p);
 
 
GRASSROOTS_USERS_API void FreeUserGroupNode (ListItem *node_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CORE_SHARED_UTIL_INCLUDE_USER_GROUP_H_ */