efl/src/lib/emile/emile_base64.h

74 lines
1.9 KiB
C
Raw Normal View History

#ifndef EMILE_BASE64_H_
#define EMILE_BASE64_H_
/**
* @defgroup Emile_Group_Base64 Non destructive base64 manipulation functions.
* @ingroup Emile
* Function that allow the encoding and decoding of base64 Eina_Binbuf.
*
* @{
*/
/**
* @brief base64 encoding function.
* @param in The buffer to be encoded.
* @return the base64 encoded string.
*
* This will create a string which is base64 encode of the buffer. The caller has
* to free the returned string using eina_strbuf_free().
*
* @since 1.17.0
*/
2020-09-21 13:28:18 -07:00
#ifndef EMILE_HEADER_ONLY
emile: Rename EAPI macro to EMILE_API in Emile library Patch from a series of patches to rename EAPI symbols to specific library DSOs. EAPI was designed to be able to pass ```__attribute__ ((visibility ("default")))``` for symbols with GCC, which would mean that even if -fvisibility=hidden was used when compiling the library, the needed symbols would get exported. MSVC __almost__ works like GCC (or mingw) in which you can declare everything as export and it will just work (slower, but it will work). But there's a caveat: global variables will not work the same way for MSVC, but works for mingw and GCC. For global variables (as opposed to functions), MSVC requires correct DSO visibility for MSVC: instead of declaring a symbol as export for everything, you need to declare it as import when importing from another DSO and export when defining it locally. With current EAPI definitions, we get the following example working in mingw and MSVC (observe it doesn't define any global variables as exported symbols). Example 1: dll1: ``` EAPI void foo(void); EAPI void bar() { foo(); } ``` dll2: ``` EAPI void foo() { printf ("foo\n"); } ``` This works fine with API defined as __declspec(dllexport) in both cases and for gcc defining as ```__atttribute__((visibility("default")))```. However, the following: Example 2: dll1: ``` EAPI extern int foo; EAPI void foobar(void); EAPI void bar() { foo = 5; foobar(); } ``` dll2: ``` EAPI int foo = 0; EAPI void foobar() { printf ("foo %d\n", foo); } ``` This will work on mingw but will not work for MSVC. And that's why EAPI is the only solution that worked for MSVC. Co-authored-by: João Paulo Taylor Ienczak Zanette <jpaulotiz@gmail.com> Co-authored-by: Ricardo Campos <ricardo.campos@expertise.dev> Co-authored-by: Lucas Cavalcante de Sousa <lucks.sousa@gmail.com>
2020-10-23 05:14:59 -07:00
EMILE_API Eina_Strbuf *emile_base64_encode(const Eina_Binbuf *in);
2020-09-21 13:28:18 -07:00
#endif
/**
* @brief base64 url and filename safe encoding function.
* @param in The buffer to be encoded.
* @return the base64 url encoded string.
*
* This will create a string which is base64 encoded with url and
* filename safe alphabet of the src. The caller has to free the
* returned string using eina_strbuf_free(). There will be no padding in the
* encoded string.
*
* @since 1.17.0
*/
2020-09-21 13:28:18 -07:00
#ifndef EMILE_HEADER_ONLY
emile: Rename EAPI macro to EMILE_API in Emile library Patch from a series of patches to rename EAPI symbols to specific library DSOs. EAPI was designed to be able to pass ```__attribute__ ((visibility ("default")))``` for symbols with GCC, which would mean that even if -fvisibility=hidden was used when compiling the library, the needed symbols would get exported. MSVC __almost__ works like GCC (or mingw) in which you can declare everything as export and it will just work (slower, but it will work). But there's a caveat: global variables will not work the same way for MSVC, but works for mingw and GCC. For global variables (as opposed to functions), MSVC requires correct DSO visibility for MSVC: instead of declaring a symbol as export for everything, you need to declare it as import when importing from another DSO and export when defining it locally. With current EAPI definitions, we get the following example working in mingw and MSVC (observe it doesn't define any global variables as exported symbols). Example 1: dll1: ``` EAPI void foo(void); EAPI void bar() { foo(); } ``` dll2: ``` EAPI void foo() { printf ("foo\n"); } ``` This works fine with API defined as __declspec(dllexport) in both cases and for gcc defining as ```__atttribute__((visibility("default")))```. However, the following: Example 2: dll1: ``` EAPI extern int foo; EAPI void foobar(void); EAPI void bar() { foo = 5; foobar(); } ``` dll2: ``` EAPI int foo = 0; EAPI void foobar() { printf ("foo %d\n", foo); } ``` This will work on mingw but will not work for MSVC. And that's why EAPI is the only solution that worked for MSVC. Co-authored-by: João Paulo Taylor Ienczak Zanette <jpaulotiz@gmail.com> Co-authored-by: Ricardo Campos <ricardo.campos@expertise.dev> Co-authored-by: Lucas Cavalcante de Sousa <lucks.sousa@gmail.com>
2020-10-23 05:14:59 -07:00
EMILE_API Eina_Strbuf *emile_base64url_encode(const Eina_Binbuf *in);
2020-09-21 13:28:18 -07:00
#endif
/**
* @brief base64 decoding function.
* @param in The string to be decoded.
* @return the base64 decoded buffer.
*
* This will create a buffer which is base64 decode of the src.
* The caller has to free the returned string using eina_binbuf_free().
*
* @since 1.17.0
*/
2020-09-21 13:28:18 -07:00
#ifndef EMILE_HEADER_ONLY
emile: Rename EAPI macro to EMILE_API in Emile library Patch from a series of patches to rename EAPI symbols to specific library DSOs. EAPI was designed to be able to pass ```__attribute__ ((visibility ("default")))``` for symbols with GCC, which would mean that even if -fvisibility=hidden was used when compiling the library, the needed symbols would get exported. MSVC __almost__ works like GCC (or mingw) in which you can declare everything as export and it will just work (slower, but it will work). But there's a caveat: global variables will not work the same way for MSVC, but works for mingw and GCC. For global variables (as opposed to functions), MSVC requires correct DSO visibility for MSVC: instead of declaring a symbol as export for everything, you need to declare it as import when importing from another DSO and export when defining it locally. With current EAPI definitions, we get the following example working in mingw and MSVC (observe it doesn't define any global variables as exported symbols). Example 1: dll1: ``` EAPI void foo(void); EAPI void bar() { foo(); } ``` dll2: ``` EAPI void foo() { printf ("foo\n"); } ``` This works fine with API defined as __declspec(dllexport) in both cases and for gcc defining as ```__atttribute__((visibility("default")))```. However, the following: Example 2: dll1: ``` EAPI extern int foo; EAPI void foobar(void); EAPI void bar() { foo = 5; foobar(); } ``` dll2: ``` EAPI int foo = 0; EAPI void foobar() { printf ("foo %d\n", foo); } ``` This will work on mingw but will not work for MSVC. And that's why EAPI is the only solution that worked for MSVC. Co-authored-by: João Paulo Taylor Ienczak Zanette <jpaulotiz@gmail.com> Co-authored-by: Ricardo Campos <ricardo.campos@expertise.dev> Co-authored-by: Lucas Cavalcante de Sousa <lucks.sousa@gmail.com>
2020-10-23 05:14:59 -07:00
EMILE_API Eina_Binbuf* emile_base64_decode(const Eina_Strbuf *in);
2020-09-21 13:28:18 -07:00
#endif
/**
* @brief decoding function for base64 url and filename safe encoding.
* @param in The string to be decoded.
* @return the base64 url decoded buffer.
*
* This will create a buffer which is base64 url decode of the src.
* The caller has to free the returned string using eina_binbuf_free().
*
* @since 1.17.0
*/
2020-09-21 13:28:18 -07:00
#ifndef EMILE_HEADER_ONLY
emile: Rename EAPI macro to EMILE_API in Emile library Patch from a series of patches to rename EAPI symbols to specific library DSOs. EAPI was designed to be able to pass ```__attribute__ ((visibility ("default")))``` for symbols with GCC, which would mean that even if -fvisibility=hidden was used when compiling the library, the needed symbols would get exported. MSVC __almost__ works like GCC (or mingw) in which you can declare everything as export and it will just work (slower, but it will work). But there's a caveat: global variables will not work the same way for MSVC, but works for mingw and GCC. For global variables (as opposed to functions), MSVC requires correct DSO visibility for MSVC: instead of declaring a symbol as export for everything, you need to declare it as import when importing from another DSO and export when defining it locally. With current EAPI definitions, we get the following example working in mingw and MSVC (observe it doesn't define any global variables as exported symbols). Example 1: dll1: ``` EAPI void foo(void); EAPI void bar() { foo(); } ``` dll2: ``` EAPI void foo() { printf ("foo\n"); } ``` This works fine with API defined as __declspec(dllexport) in both cases and for gcc defining as ```__atttribute__((visibility("default")))```. However, the following: Example 2: dll1: ``` EAPI extern int foo; EAPI void foobar(void); EAPI void bar() { foo = 5; foobar(); } ``` dll2: ``` EAPI int foo = 0; EAPI void foobar() { printf ("foo %d\n", foo); } ``` This will work on mingw but will not work for MSVC. And that's why EAPI is the only solution that worked for MSVC. Co-authored-by: João Paulo Taylor Ienczak Zanette <jpaulotiz@gmail.com> Co-authored-by: Ricardo Campos <ricardo.campos@expertise.dev> Co-authored-by: Lucas Cavalcante de Sousa <lucks.sousa@gmail.com>
2020-10-23 05:14:59 -07:00
EMILE_API Eina_Binbuf* emile_base64url_decode(const Eina_Strbuf *in);
2020-09-21 13:28:18 -07:00
#endif
/**
* @}
*/
#endif