cppinternals: Conventions

1 
1 Conventions
1 ***********
1 
1 cpplib has two interfaces--one is exposed internally only, and the other
1 is for both internal and external use.
1 
1    The convention is that functions and types that are exposed to
1 multiple files internally are prefixed with '_cpp_', and are to be found
1 in the file 'internal.h'.  Functions and types exposed to external
1 clients are in 'cpplib.h', and prefixed with 'cpp_'.  For historical
1 reasons this is no longer quite true, but we should strive to stick to
1 it.
1 
1    We are striving to reduce the information exposed in 'cpplib.h' to
1 the bare minimum necessary, and then to keep it there.  This makes clear
1 exactly what external clients are entitled to assume, and allows us to
1 change internals in the future without worrying whether library clients
1 are perhaps relying on some kind of undocumented implementation-specific
1 behavior.
1