The Cxxomfort library is distributed as "header-only", meaning it is not necessary to compile object code or link to libraries to use it[#1]. All that is necessary is essentially:
- Download a copy (pull from repository or archived release)...
- Extract / open it somewhere…
- Point your compiler's search path to the library...
For example, under Linux you can install the library by uncompressing it into a directory and then just moving the library's
cxxomfort directory under
/usr/local/include - or creating a symlink to it - and it should work out of the box without the need to add any search path, since
/usr/local/include is a "standard search path".
At the moment of release of this article, the following environments are supported:
- GCC 4.6 to 4.9
- GCC 5.5.
- MSVC 2008 Express SP1, 2010 Express.
- Clang 3.x.
Development is currently (2019) held and tested in the following testbeds, in relative order of priority:
- Debian Jessie + GCC 4.8/4.9 (main)
- Windows XP + MSVC 2008 Express / 2010 Express
- Ubuntu Trusty + GCC 4.6/5.0
Methods of Installation
Clone the repo!:
Get a hand on Fossil (external link) and use it to clone the repo:
fossil clone http://ryan.gulix.cl/fossil.cgi/cxxomfort cxxomfort.fossil
Create a directory and from within there open the repository file.
mkdir cxxomfort && cd cxxomfort fossil open ../cxxomfort.fossil
Or download an archive!:
- browse "Files" in the upper navigation bar to get a tarball of the current contents of the repo.
- directly download a zipball of the latest version via this link.
Make the library available
For the library to be visible to your compiler / project, just add the path to its child "cxxomfort" folder to your compiler / project's search paths.
# For most compilers, something like this works: compiler -I /path/to/cxxomfort-release files.cpp ...
If you have the necessary permissions, you can copy or symlink the child "cxxomfort" path to one of the already existing default include paths in your system. For example, for GCC in Linux:
ln -s /path/to/cxxomfort-release/cxxomfort /usr/local/include/cxxomfort
In order to stay updated -if you cloned the repo - all that is necessary is to clean your local copy's working directory, then issue fossil's own command to update:
fossil clean fossil update
For users updating from 0.45 or below: You will need to perform a
fossil clean -x before updating, and then you'll need to repoint your compiler's search path to the new cxxomfort directory, as of 0.51 onwards the file structure has changed. In case of doubts, you can also
fossil close, delete the clone directory and repo and then download from scratch as well.
The library also includes a tags file for the Geany IDE (http://www.geany.org/), under the directory
tags/. Simply copy the tags file to your Geany profile's tags directory - under Linux, something like
The tags file includes a number of cxxomfort constructs such as:
- behaviour macros like
- code-generation macros like
- library-specific functions such as
Note that the tags file does not mention Standard C++ names, even the ones the library backports like
nullptr. For those, it would be better for the user to get tags files for the C++ language and its related facilities. One such example is this std.cpp tags.
Downloading the Documentation
To be included: a zip file with the documentation from this site.
1 Which is why it does not include a "Makefile", though adding one will be done eventually.
→ Proceed with the Configuration