I'm struggling to find pragmatic real-world advice on function naming conventions for a medium sized C library project. My library project is separated into a few modules and submodules with their own headers, and loosely follows an OO style (all functions take a certain struct as first argument, no globals etc). It's laid our something like:
MyLib - Foo - foo.h - foo_internal.h - some_foo_action.c - another_foo_action.c - Baz - baz.h - some_baz_action.c - Bar - bar.h - bar_internal.h - some_bar_action.c
Generally the functions are far too big to (for example) stick
another_foo_action in one
foo.c implementation file, make most functions static, and call it a day.
I can deal with stripping my internal ("module private") symbols when building the library to avoid conflicts for my users with their client programs, but the question is how to name symbols in my library? So far I've been doing:
struct MyLibFoo; void MyLibFooSomeAction(MyLibFoo *foo, ...); struct MyLibBar; void MyLibBarAnAction(MyLibBar *bar, ...); // Submodule struct MyLibFooBaz; void MyLibFooBazAnotherAction(MyLibFooBaz *baz, ...);
But I'm ending up with crazy long symbol names (much longer than the examples). If I don't prefix the names with a "fake namespace", modules' internal symbol names all clash.
Note: I don't care about camelcase/Pascal case etc, just the names themselves.
Prefixing (well, affixing) is really the only option. Some patterns you'll see are
<library>_<name> (e.g., OpenGL, ObjC runtime),
<module/class>_<name> (e.g. parts of Linux),
<library>_<module/class>_<name> (e.g., GTK+). Your scheme is perfectly reasonable.
Long names aren't necessarily bad if they are predictable. The fact that you are ending up with crazy long names and functions that are too big to stick with related functions in a single source file raises different concerns. Do you have some more concrete examples?
git mergeing. As an example I have a module for drawing UI with OpenGL, and I have separate
.cfiles for each element that I need (
indicator.cetc). These element implementations have a main drawing function maybe a few hundred lines long, and a fair number of
statichelpers within. They also call a few pure geometry functions from within the UI module. Does that sound fairly typical? — Jun 20, 2013 at 15:50
Audio Module > Engines > Channels > Filterswhich means something like
MyLibAudioEngines<EngineName>Channel<ActionName>. Or in my filters submodule:
MyLibAudioFiltersBigSoundingCompressorFloat32Process— Jun 20, 2013 at 15:58