1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
libpsyc/include/psyc.h

171 lines
3.5 KiB
C
Raw Normal View History

2011-05-09 12:37:57 +00:00
/**
* @file psyc.h
* @brief Main PSYC interface providing crucial functionality.
2011-05-09 12:37:57 +00:00
*/
2011-04-19 20:57:49 +00:00
2011-05-09 12:37:57 +00:00
/**
* @mainpage PSYC Core Library
2011-04-19 20:57:49 +00:00
*
* @section intro_sec Introduction
*
2011-05-09 07:11:59 +00:00
* Welcome to the libpsyc documentation!
2011-04-19 20:57:49 +00:00
*
* @section install_sec Installation
*/
2011-05-09 12:37:57 +00:00
// * @subsection step1 Step 1: Opening the box
2011-04-19 20:57:49 +00:00
#ifndef PSYC_H
2011-04-16 15:30:03 +00:00
#include <stdint.h>
#include <string.h>
#include <sys/types.h>
2011-04-16 15:30:03 +00:00
2011-11-03 13:27:01 +00:00
#define PSYC_VERSION 1
#define PSYC_EPOCH 1440444041 // 2015-08-24 21:20:41 CET (Monday)
2011-04-16 15:30:03 +00:00
#define PSYC_C2STR(str) {sizeof(str)-1, str}
#define PSYC_C2ARG(str) str, sizeof(str)-1
2011-11-01 21:24:35 +00:00
#define PSYC_C2ARG2(str) sizeof(str)-1, str
2011-11-01 11:06:58 +00:00
#define PSYC_S2ARG(str) (str).data, (str).length
#define PSYC_S2ARG2(str) (str).length, (str).data
2011-10-31 19:04:16 +00:00
#define PSYC_NUM_ELEM(a) (sizeof(a) / sizeof(*(a)))
typedef enum
{
PSYC_FALSE = 0,
PSYC_TRUE = 1,
2011-10-30 15:04:54 +00:00
PSYC_NO = 0,
PSYC_YES = 1,
2011-10-31 19:26:47 +00:00
} PsycBool;
2011-11-01 11:06:58 +00:00
typedef enum
{
PSYC_OK = 1,
PSYC_ERROR = -1,
} PsycRC;
/**
* PSYC packet parts.
*/
typedef enum
{
PSYC_PART_RESET = -1,
PSYC_PART_ROUTING = 0,
PSYC_PART_LENGTH = 1,
PSYC_PART_CONTENT = 2,
PSYC_PART_METHOD = 3,
PSYC_PART_DATA = 4,
PSYC_PART_END = 5,
2011-10-31 19:26:47 +00:00
} PsycPart;
/**
* Different types that a variable can have.
*
* This enum lists PSYC variable types that
* this library is capable of checking for
* validity. Other variable types are treated
* as opaque data.
*/
typedef enum
{
2011-04-22 15:09:32 +00:00
PSYC_TYPE_UNKNOWN,
PSYC_TYPE_AMOUNT,
PSYC_TYPE_COLOR,
PSYC_TYPE_DATE,
PSYC_TYPE_DEGREE,
PSYC_TYPE_ENTITY,
PSYC_TYPE_FLAG,
PSYC_TYPE_LANGUAGE,
PSYC_TYPE_LIST,
PSYC_TYPE_NICK,
PSYC_TYPE_PAGE,
PSYC_TYPE_UNIFORM,
PSYC_TYPE_TIME,
2011-10-31 19:26:47 +00:00
} PsycType;
/**
* List types.
* Possible types are text and binary.
*/
typedef enum
{
PSYC_LIST_TEXT = 1,
PSYC_LIST_BINARY = 2,
2011-10-31 19:26:47 +00:00
} PsycListType;
2011-05-08 23:49:04 +00:00
/**
* String struct.
*
* Contains pointer and length for a buffer.
*/
2011-04-22 15:09:32 +00:00
typedef struct
{
2011-05-08 23:49:04 +00:00
/// Length of the data pointed to by ptr
2011-05-28 17:39:42 +00:00
size_t length;
2011-05-08 23:49:04 +00:00
/// pointer to the data
2011-11-01 11:06:58 +00:00
char *data;
2011-10-31 19:26:47 +00:00
} PsycString;
2011-04-22 15:09:32 +00:00
2011-04-29 20:58:19 +00:00
typedef struct
{
2011-10-31 19:26:47 +00:00
PsycString key;
2011-11-01 11:06:58 +00:00
void *value;
} PsycDict;
typedef struct
{
PsycString key;
intptr_t value;
} PsycDictInt;
2011-04-29 20:58:19 +00:00
/**
2011-10-31 19:04:16 +00:00
* Checks if long keyword string inherits from short keyword string.
*/
2011-10-31 19:04:16 +00:00
int psyc_inherits (char *sho, size_t slen,
char *lon, size_t llen);
/**
2011-10-31 19:04:16 +00:00
* Checks if short keyword string matches long keyword string.
*/
2011-10-31 19:04:16 +00:00
int psyc_matches (char *sho, size_t slen,
char *lon, size_t llen);
2011-10-30 15:04:54 +00:00
/**
2011-11-01 11:06:58 +00:00
* Look up value associated with a key in a dictionary.
2011-10-30 15:04:54 +00:00
*
2011-11-01 11:06:58 +00:00
* @param dict The dictionary to search, should be ordered alphabetically.
* @param size Size of dict.
* @param key Key to look for.
* @param keylen Length of key.
* @param inherit If true, also look for anything inheriting from key,
otherwise only exact matches are returned.
* @param tmp A temporary array used for keeping track of results.
* Should be the same size as dict.
2011-10-30 15:04:54 +00:00
*
2011-11-01 11:06:58 +00:00
* @return The value of the entry if found, or NULL if not found.
2011-10-30 15:04:54 +00:00
*/
2011-11-01 11:06:58 +00:00
void * psyc_dict_lookup (const PsycDict *dict, size_t size,
const char *key, size_t keylen,
PsycBool inherit, int8_t *tmp);
/**
* Look up value associated with a key in a dictionary of integers.
* @see psyc_dict_lookup
*/
static inline
intptr_t psyc_dict_lookup_int (const PsycDictInt *dict, size_t size,
const char *key, size_t keylen,
PsycBool inherit, int8_t *tmp)
{
return (intptr_t) psyc_dict_lookup((PsycDict *)dict, size, key, keylen, inherit, tmp);
}
2011-10-31 19:04:16 +00:00
#include "psyc/variable.h"
2011-04-16 15:30:03 +00:00
2011-05-09 07:02:15 +00:00
#define PSYC_H
#endif