malvineous/cfgpath

Cross platform C header for obtaining paths to user configuration files and directories

cfgpath.h: Cross platform methods for obtaining paths to configuration files

Copyright 2013 Adam Nielsen [email protected]

---

This is a simple header file that provides a handful of functions to obtain paths to configuration files, regardless of the operating system the application is running under.

It requires no dependencies beyond each platform's standard API.

This code is placed in the public domain. You are free to use it for any purpose. If you add new platform support, please contribute a patch!

Basic use:

#include "cfgpath.h"

char cfgdir[MAX_PATH];
get_user_config_file(cfgdir, sizeof(cfgdir), "myapp");
if (cfgdir[0] == 0) {
    printf("Unable to find home directory.\n");
    return 1;
}
printf("Saving configuration file to %s\n", cfgdir);

To integrate it into your own project, just copy cfgpath.h. All the other files are for testing to make sure it works correctly, so you don't need them unless you intend to make changes and send me a patch.

Supported platforms are currently:

• Linux
• Mac OS X
• Windows

Patches adding support for more platforms would be greatly appreciated.

cfgpath's Issues

Bad C++ compatibility

It's me again! Can you put all four functions in a namespace when compiling in c++?
Quick patch:

#ifdef __cplusplus
namespace cfgpath {
#endif

// code

#ifdef __cplusplus
} // cfgpath
#endif

Deprecated functions FSFindFolder and FSRefMakePath since macOS 10.8 (Mountain Lion)

Those functions are now deprecated (and other symbols too). The compiler warns me but I can use -Wno-deprecated-declarations so it is fine. I'm working on a new patch to replace those functions by more modern alternatives.

Move tests to a dedicated folder to allow adding root project folder to include path

At the moment, the windows implementation relies on shlobj.h

But if I add the root project folder to include path, the shlobj.h in root project folder is used instead of the actual system one, causing functions like SHGetFolderPath to not be found.

This can be solved by simply moving the test into its own folder.

Licensing is unclear

I really love this project, however, I am unable to incorporate it's wondrous abilities into our programs due to the licensing not being defined on this platform.
This stackoverflow answer mentioned it's public domain, but I can't verify the authenticity of that claim.

https://stackoverflow.com/a/18418391

Please update your license definition to match how you wish this code to be treated.
Thanks!!!!!

SHGetFolderPath is Deprecated

This function is deprecated. On Windows Vista/7/8/10, should be SHGetKnownFolderPath

https://msdn.microsoft.com/en-us/library/windows/desktop/bb762181(v=vs.85).aspx

Null termination is missing for path string on linux

When the application tries to create a directory on linux. It segfaults because the path is populated with random characters due to a missing null termination.

At this line

cfgpath/cfgpath.h

Line 129 in 50b451a

/* Make the .config folder if it doesn't already exist */