I know this is probably a primitive topic for most, but I just got into coding in c++ because a simple project I am working on that uses esp8266 which can be programmed using c++. Before this I only had experiemce with python, javascript and typescript.
Now to my problem: I am trying to split my code that is getting longer into multiple files.
I already think that I understand right that each library has a header (.h) file and source (.cpp or .c in case of c) file. The first thing I already have problem with is that as you are defining your functions and classes in the header file and then implementing them in the source file you are repeating yourself with the declarations which is not something I would like. I presume that most IDEs will probably automatically help you with generating or editing the header file automatically as you change code in the source file and I guess I will need to learn to live with it.
Then there’s the thing with importing. It may happen that if you create a library it also has some dependencies that it needs to include. But as far as I understand one library shouldn’t be included multiple times. So from what I can see most libraries check whether a global variable with an ARBITRARY name that the library chooses itself is not defined and then if that’s true it defines that variable to indicate it has been included (the name of the variable is not compketely arbitrary and usually follows LIBRARY_NAME_H but the convention cannot be really relyed on). When the library includes other library it also needs to check whether the variable of that library that is defined on its import is defined. The main file should also probably check this for every library it includes because it can’t know what lins were already imported by libs it imported? Am I getting something wrong or is it sometimes ok for some libraries to be included multiple times. There’s the to handle these situations?
Thank you for your explanation! From what I have read ‘#pragma once’ solves the problem with mutiple includes for most modern compilers, but it’s always better to write the import guards for better compatability?
You probably don’t have to worry about the compatability of
#pragma onceso just use that. The only reasons to not use it is if it’s important to only use standard compliant c for whatever reason or if you need to support some arcane compiler that doesn’t support#pragma once. Realistically, neither of these are situations that you’ll ever be put in and if you are you probably have much larger things that you need to worry about.There’s no downside to writing the guards afaik, but I’m more of a c programmer. It’s been a while since I did much c++, so I’m not up on modern conventions. But dealing with legacy code adhering to older conventions often comes with the territory with c and c++, so it’s something to keep in mind.
Header guards and #pragma once serve the same purpose, so i’d say use whichever method you want. #pragma once should exist on most modern compilers. If your compiler doesn’t support that, then normal header guards.
one advantage of #pragma once is that it reduces the pollution of #defines that header guards introduce. For every header file, there would be one #define FILE_NAME. Depending on your naming convention of these defines, it may clutter up the global namespace in the long run.
Header guards, like you said, provide better compatibility. At the end of the day, use whichever you want. i use #pragma once because it’s much more convenient. I hope this answers your question!
Edit: oh and of course, if the existing code base is using either one of those ways, stick to that same convention!