tip/dav/tags.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2018 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef TAGS_H
#define TAGS_H

#include <cx/string.h>
#include <cx/buffer.h>
#include <cx/list.h>

#include <libidav/webdav.h>

#ifdef __cplusplus
extern "C" {
#endif


/* OFF must be zero, other constants are arbitrary */
#define DAV_SYNC_TAGFILTER_OFF     0
#define DAV_SYNC_TAGFILTER_AND     1
#define DAV_SYNC_TAGFILTER_OR      2
#define DAV_SYNC_TAGFILTER_ONE     3
#define DAV_SYNC_TAGFILTER_NONE    4
    
#define DAV_SYNC_TAGFILTER_SCOPE_RESOURCE   1
#define DAV_SYNC_TAGFILTER_SCOPE_COLLECTION 2
    
typedef struct DavTag {
    char *name;
    char *color;
} DavTag;

/**
 * filter ::= operator? , (tag_list | ("(" , filter , ")")+)
 * tag_list ::= tag , ("," tag)*
 * operator ::= "&" | "|" | "1" | "0"
 */
typedef struct SyncTagFilter SyncTagFilter;

struct SyncTagFilter {
    int scope;
    int mode;
    CxList* tags;
    size_t subfilter_count;
    SyncTagFilter** subfilters;
};

void free_dav_tag(DavTag* tag);

void free_taglist(CxList *list);

int compare_tagname(DavTag* left, DavTag* right, void* ignorecase);

CxMap* taglist2map(CxList *tags);

CxList* parse_text_taglist(const char *buf, size_t length);
CxBuffer* create_text_taglist(CxList *tags);

CxList* parse_csv_taglist(const char *buf, size_t length);
CxBuffer* create_csv_taglist(CxList *tags);

CxList* parse_dav_xml_taglist(DavXmlNode *taglistnode);
DavXmlNode* create_xml_taglist(CxList *tags);

CxList* parse_macos_taglist(const char *buf, size_t length);
CxBuffer* create_macos_taglist(CxList *tags);

int compare_taglists(CxList *tags1, CxList *tags2);

char* create_tags_hash(CxList *tags);

CxList* merge_tags(CxList *tags1, CxList *tags2);

/*
 * Adds tag colors from the colored list to taglist if tags have the same name
 */
void add_tag_colors(CxList *taglist, CxList *colored);

/* ----------- ----------- tag filter  ---------------------- */

SyncTagFilter* parse_tagfilter_string(const char* filterstring, int scope);
void free_tagfilter(SyncTagFilter* filter);

int matches_tagfilter(CxList *dav_tags, SyncTagFilter *tagfilter);

#ifdef __cplusplus
}
#endif

#endif /* TAGS_H */