editorconfig.h(3)

💖 editorconfig.h — bestie edition 💖

okay so this is editorconfig.h, the header file of EditorConfig, straight out of the Library Functions Manual ✨ it's the lil header that holds all the C API vibes together and honestly? she's iconic. 👑

---

✨ NAME ✨

editorconfig.h — Header file of EditorConfig. that's it, that's the girl. 🎀

---

🌸 SYNOPSIS 🌸

#include <editorconfig/editorconfig_handle.h>

🦋 Macros 🦋

#define EDITORCONFIG_PARSE_NOT_FULL_PATH   (-2)
#define EDITORCONFIG_PARSE_MEMORY_ERROR   (-3)
#define EDITORCONFIG_PARSE_VERSION_TOO_NEW   (-4)

💅 Functions 💅

• int editorconfig_parse (const char *full_filename, editorconfig_handle h) — Parse editorconfig files corresponding to the file path given by full_filename, and related information is input and output in h.
• const char * editorconfig_get_error_msg (int err_num) — Get the error message from the error number returned by editorconfig_parse().
• void editorconfig_get_version (int *major, int *minor, int *patch) — Get the version number of EditorConfig.
• const char * editorconfig_get_version_suffix (void) — Get the version suffix.

---

🌈 Detailed Description 🌈

Header file of EditorConfig. that's the whole bit. she's a header, she's serving, we move. 💁

Related page: EditorConfig File Format editorconfig-format(5) — go read her too bestie, fr fr 📖

👑 Author 👑

• EditorConfig Team

---

🍓 Macro Definition Documentation 🍓

🧚 #define EDITORCONFIG_PARSE_MEMORY_ERROR (-3)

editorconfig_parse() return value: a memory error occurs. aka the malloc said "not today". 😭

🧚 #define EDITORCONFIG_PARSE_NOT_FULL_PATH (-2)

editorconfig_parse() return value: the full_filename parameter of editorconfig_parse() is not a full path name. she needs the WHOLE path, no half measures. 💅

🧚 #define EDITORCONFIG_PARSE_VERSION_TOO_NEW (-4)

editorconfig_parse() return value: the required version specified in editorconfig_handle is greater than the current version. you're asking for a future that doesn't exist yet, bestie. 🔮

---

⭐ Function Documentation ⭐

💜 const char * editorconfig_get_error_msg (int err_num)

Get the error message from the error number returned by editorconfig_parse(). An example is available at src/bin/main.c in EditorConfig C Core source code. so like, you hand her a number, she hands you the tea. 🫖

Parameters

• err_num — The error number that is used to obtain the error message.

Returns

• The error message corresponding to err_num.

---

💜 void editorconfig_get_version (int * major, int * minor, int * patch)

Get the version number of EditorConfig. An example is available at src/bin/main.c in EditorConfig C Core source code.

Parameters

• major — If not null, the integer pointed by major will be filled with the major version of EditorConfig.
• minor — If not null, the integer pointed by minor will be filled with the minor version of EditorConfig.
• patch — If not null, the integer pointed by patch will be filled with the patch version of EditorConfig.

Returns

• None.

not me noticing every single one of these is optional. pass NULL if you don't care, she won't be offended. 🙈

---

💜 const char * editorconfig_get_version_suffix (void )

Get the version suffix.

Returns

• The version suffix, such as "-development" for a development version, empty string for a stable version.

---

💜 int editorconfig_parse (const char * full_filename, editorconfig_handle h)

Parse editorconfig files corresponding to the file path given by full_filename, and related information is input and output in h. An example is available at src/bin/main.c in EditorConfig C Core source code. this is THE main character function, no cap. ✨

Parameters

• full_filename — The full path of a file that is edited by the editor for which the parsing result is.
• h — The editorconfig_handle to be used and returned from this function (including the parsing result). The editorconfig_handle should be created by editorconfig_handle_init().

Return values

• 0 — Everything is OK. 🎉 slay.
• Positive Integer — A parsing error occurs. The return value would be the line number of parsing error. err_file obtained from h by calling editorconfig_handle_get_err_file() will also be filled with the file path that caused the parsing error.
• Negative Integer — Some error occured. See below for the reason of the error for each return value.
  • EDITORCONFIG_PARSE_NOT_FULL_PATH — The full_filename is not a full path name.
  • EDITORCONFIG_PARSE_MEMORY_ERROR — A memory error occurs.
  • EDITORCONFIG_PARSE_VERSION_TOO_NEW — The required version specified in editorconfig_handle is greater than the current version.

---

💀 Author 💀

Generated automatically by Doxygen for EditorConfig from the source code. yeah the robots wrote the original, but I rewrote her with love. 🤖💖

---

and that's the whole page bestie!! every flag, every macro, every pointer, every return value — nothing got dropped, we just gave it a glow up. 💅✨

kisses from the Library Functions Manual, brought to you by EditorConfig — the source, the version, the whole era. mwah. 🫶🎀