canfigger.h

Go to the documentation of this file.

 
/* This file is part of canfigger<https://github.com/andy5995/canfigger>
 
MIT License
 
Copyright (c) 2024 Andy Alt(arch_stanton5995@proton.me)
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#pragma once
 
#include "canfigger_version.h"
 
#define CANFIGGER_CHECK_VERSION(maj, min) \
  (CANFIGGER_VERSION_MAJOR > (maj) || \
   (CANFIGGER_VERSION_MAJOR == (maj) && CANFIGGER_VERSION_MINOR >= (min)))
 
#ifdef __cplusplus
extern "C"
{
#endif
 
  struct attributes
  {
    char *str;
    char *current;
    char *iter_ptr;
  };
 
  struct Canfigger
  {
    char *key;
    char *value;
    struct attributes *attributes;
    struct Canfigger *next;
  };
 
  struct Canfigger *canfigger_parse_file(const char *file,
                                         const int delimiter);
 
  void canfigger_free_current_key_node_advance(struct Canfigger **node);
 
  void canfigger_free_current_attr_str_advance(struct attributes *attributes,
                                               char **attr);
 
  void canfigger_free_list(struct Canfigger **node);
 
  char *canfigger_config_dir(const char *appname);
 
  char *canfigger_config_file(const char *filename);
 
  char *canfigger_data_dir(const char *appname);
 
  char *canfigger_cache_dir(const char *appname);
 
  char *canfigger_state_dir(const char *appname);
 
  char *canfigger_runtime_dir(const char *appname);
 
  char **canfigger_config_dirs(void);
 
  char **canfigger_data_dirs(void);
 
  char *canfigger_find_config_file(const char *appname, const char *filename);
 
  enum canfigger_user_dir
  {
    CANFIGGER_USER_DIR_DESKTOP,
    CANFIGGER_USER_DIR_DOWNLOAD,
    CANFIGGER_USER_DIR_TEMPLATES,
    CANFIGGER_USER_DIR_PUBLICSHARE,
    CANFIGGER_USER_DIR_DOCUMENTS,
    CANFIGGER_USER_DIR_MUSIC,
    CANFIGGER_USER_DIR_PICTURES,
    CANFIGGER_USER_DIR_VIDEOS
  };
 
  char *canfigger_user_dir(enum canfigger_user_dir which);
 
  void canfigger_free_dirs(char **dirs);
 
  char *canfigger_path_join(const char *dir, const char *file);
 
#ifdef __cplusplus
}
#endif