complete.h

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
 */
 
#pragma once
 
#include <stdio.h>
#include <sys/queue.h>
#include <sys/types.h>
 
struct ec_node;
struct ec_strvec;
 
struct ec_comp_item;
 
struct ec_comp_group;
 
struct ec_comp;
 
enum ec_comp_type {
    EC_COMP_UNKNOWN = 0x1, 
    EC_COMP_FULL = 0x2, 
    EC_COMP_PARTIAL = 0x4, 
    EC_COMP_ALL = 0x7, 
};
 
struct ec_comp *ec_complete(const struct ec_node *node, const char *str);
 
struct ec_comp *ec_complete_strvec(const struct ec_node *node, const struct ec_strvec *strvec);
 
struct ec_strvec *ec_complete_strvec_expand(
    const struct ec_node *node,
    enum ec_comp_type type,
    const struct ec_strvec *strvec
);
 
int ec_complete_child(
    const struct ec_node *node,
    struct ec_comp *comp,
    const struct ec_strvec *strvec
);
 
struct ec_comp *ec_comp(void);
 
void ec_comp_free(struct ec_comp *comp);
 
void ec_comp_dump(FILE *out, const struct ec_comp *comp);
 
int ec_comp_merge(struct ec_comp *to, struct ec_comp *from);
 
struct ec_pnode *ec_comp_get_cur_pstate(const struct ec_comp *comp);
 
struct ec_comp_group *ec_comp_get_cur_group(const struct ec_comp *comp);
 
struct ec_dict *ec_comp_get_attrs(const struct ec_comp *comp);
 
struct ec_comp_item *ec_comp_add_item(
    struct ec_comp *comp,
    const struct ec_node *node,
    enum ec_comp_type type,
    const char *current,
    const char *full
);
 
const char *ec_comp_item_get_str(const struct ec_comp_item *item);
 
const char *ec_comp_item_get_display(const struct ec_comp_item *item);
 
const char *ec_comp_item_get_completion(const struct ec_comp_item *item);
 
const char *ec_comp_item_get_current(const struct ec_comp_item *item);
 
const struct ec_comp_group *ec_comp_item_get_grp(const struct ec_comp_item *item);
 
enum ec_comp_type ec_comp_item_get_type(const struct ec_comp_item *item);
 
const struct ec_node *ec_comp_item_get_node(const struct ec_comp_item *item);
 
int ec_comp_item_set_str(struct ec_comp_item *item, const char *str);
 
int ec_comp_item_set_display(struct ec_comp_item *item, const char *display);
 
int ec_comp_item_set_completion(struct ec_comp_item *item, const char *completion);
 
const struct ec_node *ec_comp_group_get_node(const struct ec_comp_group *grp);
 
const struct ec_pnode *ec_comp_group_get_pstate(const struct ec_comp_group *grp);
 
const struct ec_dict *ec_comp_group_get_attrs(const struct ec_comp_group *grp);
 
int ec_complete_unknown(
    const struct ec_node *node,
    struct ec_comp *comp,
    const struct ec_strvec *strvec
);
 
size_t ec_comp_count(const struct ec_comp *comp, enum ec_comp_type type);
 
struct ec_comp_item *ec_comp_iter_first(const struct ec_comp *comp, enum ec_comp_type type);
 
struct ec_comp_item *ec_comp_iter_next(struct ec_comp_item *item, enum ec_comp_type type);
 
#define EC_COMP_FOREACH(item, comp, type)                                                          \
    for (item = ec_comp_iter_first(comp, type); item != NULL;                                  \
         item = ec_comp_iter_next(item, type))