/*
* symbols.c - routines for symbol handling
*
* Copyright (C) 2014 Ondrej Oprala <ooprala@redhat.com>
* Copyright (C) 2016 Igor Gnatenko <i.gnatenko.brain@gmail.com>
*
* This file may be redistributed under the terms of the
* GNU Lesser General Public License.
*/
/**
* SECTION: symbols
* @title: Symbols
* @short_description: can be used to overwrite default output chars (for ascii art)
*
* An API to access and modify data and information per symbol/symbol group.
*/
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "smartcolsP.h"
/**
* scols_new_symbols:
*
* Returns: a pointer to a newly allocated struct libscols_symbols instance.
*/
struct libscols_symbols *scols_new_symbols(void)
{
struct libscols_symbols *sy = calloc(1, sizeof(struct libscols_symbols));
if (!sy)
return NULL;
sy->refcount = 1;
return sy;
}
/**
* scols_ref_symbols:
* @sy: a pointer to a struct libscols_symbols instance
*
* Increases the refcount of @sy.
*/
void scols_ref_symbols(struct libscols_symbols *sy)
{
if (sy)
sy->refcount++;
}
/**
* scols_unref_symbols:
* @sy: a pointer to a struct libscols_symbols instance
*
* Decreases the refcount of @sy.
*/
void scols_unref_symbols(struct libscols_symbols *sy)
{
if (sy && --sy->refcount <= 0) {
free(sy->tree_branch);
free(sy->tree_vert);
free(sy->tree_right);
free(sy->group_last_member);
free(sy->group_middle_member);
free(sy->group_first_member);
free(sy->group_vert);
free(sy->group_horz);
free(sy->group_last_child);
free(sy->group_middle_child);
free(sy->title_padding);
free(sy->cell_padding);
free(sy);
}
}
/**
* scols_symbols_set_branch:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the branch part of a tree output
*
* Returns: 0, a negative value in case of an error.
*/
int scols_symbols_set_branch(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, tree_branch, str);
}
/**
* scols_symbols_set_vertical:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the vertical part of a tree output
*
* Returns: 0, a negative value in case of an error.
*/
int scols_symbols_set_vertical(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, tree_vert, str);
}
/**
* scols_symbols_set_right:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the right part of a tree output
*
* Returns: 0, a negative value in case of an error.
*/
int scols_symbols_set_right(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, tree_right, str);
}
/**
* scols_symbols_set_title_padding:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the symbols which fill title output
*
* The current implementation uses only the first byte from the padding string.
* A multibyte chars are not supported yet.
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.28
*/
int scols_symbols_set_title_padding(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, title_padding, str);
}
/**
* scols_symbols_set_cell_padding:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the symbols which fill cells
*
* The padding char has to take up just one cell on the terminal.
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.29
*/
int scols_symbols_set_cell_padding(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, cell_padding, str);
}
/**
* scols_symbols_set_group_vertical:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the vertival line
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_vertical(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_vert, str);
}
/**
* scols_symbols_set_group_horizontal:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent the horizontal line
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_horizontal(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_horz, str);
}
/**
* scols_symbols_set_group_first_member:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent first member
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_first_member(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_first_member, str);
}
/**
* scols_symbols_set_group_last_member:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent last member
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_last_member(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_last_member, str);
}
/**
* scols_symbols_set_group_middle:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent middle member
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_middle_member(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_middle_member, str);
}
/**
* scols_symbols_set_group_last_child:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent last child
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_last_child(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_last_child, str);
}
/**
* scols_symbols_set_group_middle_child:
* @sy: a pointer to a struct libscols_symbols instance
* @str: a string which will represent last child
*
* Returns: 0, a negative value in case of an error.
*
* Since: 2.34
*/
int scols_symbols_set_group_middle_child(struct libscols_symbols *sy, const char *str)
{
return strdup_to_struct_member(sy, group_middle_child, str);
}
/**
* scols_copy_symbols:
* @sy: a pointer to a struct libscols_symbols instance
*
* Returns: a newly allocated copy of the @sy symbol group or NULL in case of an error.
*/
struct libscols_symbols *scols_copy_symbols(const struct libscols_symbols *sy)
{
struct libscols_symbols *ret;
int rc;
assert(sy);
if (!sy)
return NULL;
ret = scols_new_symbols();
if (!ret)
return NULL;
rc = scols_symbols_set_branch(ret, sy->tree_branch);
if (!rc)
rc = scols_symbols_set_vertical(ret, sy->tree_vert);
if (!rc)
rc = scols_symbols_set_right(ret, sy->tree_right);
if (!rc)
rc = scols_symbols_set_group_vertical(ret, sy->group_vert);
if (!rc)
rc = scols_symbols_set_group_horizontal(ret, sy->group_horz);
if (!rc)
rc = scols_symbols_set_group_first_member(ret, sy->group_first_member);
if (!rc)
rc = scols_symbols_set_group_last_member(ret, sy->group_last_member);
if (!rc)
rc = scols_symbols_set_group_middle_member(ret, sy->group_middle_member);
if (!rc)
rc = scols_symbols_set_group_middle_child(ret, sy->group_middle_child);
if (!rc)
rc = scols_symbols_set_group_last_child(ret, sy->group_last_child);
if (!rc)
rc = scols_symbols_set_title_padding(ret, sy->title_padding);
if (!rc)
rc = scols_symbols_set_cell_padding(ret, sy->cell_padding);
if (!rc)
return ret;
scols_unref_symbols(ret);
return NULL;
}
