clif.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <sys/types.h>
 
#include "clif_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum {
    CLIF_OK          = 0,    
    CLIF_NO_SPACE    = -1,   
    CLIF_NOT_FOUND   = -2    
};

typedef enum {
    CLIF_ATTR_ANCHOR        = 0,  
    CLIF_ATTR_REL           = 1,  
    CLIF_ATTR_LANG          = 2,  
    CLIF_ATTR_MEDIA         = 3,  
    CLIF_ATTR_TITLE         = 4,  
    CLIF_ATTR_TITLE_EXT     = 5,  
    CLIF_ATTR_TYPE          = 6,  
    CLIF_ATTR_RT            = 7,  
    CLIF_ATTR_IF            = 8,  
    CLIF_ATTR_SZ            = 9,  
    CLIF_ATTR_CT            = 10, 
    CLIF_ATTR_OBS           = 11, 
    CLIF_ATTR_EXT           = 12  
} clif_attr_type_t;

typedef struct {
    char *value;                   
    unsigned value_len;            
    const char *key;               
    unsigned key_len;              
} clif_attr_t;

typedef struct {
    char *target;                
    unsigned target_len;         
    clif_attr_t *attrs;          
    unsigned attrs_len;          
} clif_t;

ssize_t clif_encode_link(const clif_t *link, char *buf, size_t maxlen);

ssize_t clif_decode_link(clif_t *link, clif_attr_t *attrs, unsigned attrs_len,
                         char *buf, size_t maxlen);

ssize_t clif_add_target_from_buffer(const char *target, size_t target_len,
                                    char *buf, size_t maxlen);

ssize_t clif_add_target(const char *target, char *buf, size_t maxlen);

ssize_t clif_add_attr(clif_attr_t *attr, char *buf, size_t maxlen);

ssize_t clif_add_link_separator(char *buf, size_t maxlen);

ssize_t clif_get_target_const(const char *input, size_t input_len, const char **output);

static inline ssize_t clif_get_target(char *input, size_t input_len, char **output)
{
    return clif_get_target_const(input, input_len, (const char **)output);
}

ssize_t clif_get_attr(const char *input, size_t input_len, clif_attr_t *attr);

clif_attr_type_t clif_get_attr_type(const char *input, size_t input_len);

ssize_t clif_attr_type_to_str(clif_attr_type_t type, const char **str);

int clif_init_attr(clif_attr_t *attr, clif_attr_type_t type);
 
#ifdef __cplusplus
}
#endif