Text 25, 60 rader
Skriven 2004-07-27 19:22:19 av George White (2:250/501.3)
     Kommentar till text 11 av Bruce Partridge (1:261/38)
Ärende: [C] Code File Structure
===============================
Hi Bruce,

On 24-Jul-04, Bruce Partridge wrote to All:

 BP> I'm a long time programmer, but I have only been using C for the
 BP> last couple of years.

 BP> I'm interested in finding a document or book that explains how to
 BP> split modules into files.  I have done several different things,
 BP> and none of them seem perfect!

I've not seen one...
There is _no_ perfect way, it is a personal choice!

 BP> Global and local variables seem to be obvious, but where is the
 BP> "normal" place to put hardware defines.  For example, I use
 BP> hardware defines that only apply if I have a certain type of
 BP> temperature sensor.  A different sensor uses different defines.
 BP> Should these be in a global hw.h file or in the module code file?

In a specific global "temp_hw.h" file included where needed, in my
style containing all the #defines needed and using an

#ifdef TEMPERATURE_MAKE_1
/* all the #defines for MAKE_1 */
#else
#ifdef TEMPERATURE_MAKE_2
/* all the #defines for MAKE_2 */
#else
/* Catch no hardware defined, or else put default parameters here */
#error No temperature sensor hardware #defined
#endif

construct, with a global #define for the make in a site/hardware
control file (I use "site.h", not very original but perfectly
obvious).

 BP> And where do you define enums that are used in several modules.
 BP> For example, I have a state machine.   Other modules sometimes
 BP> need to know th current state.  Right now I have a enum.h file to
 BP> define the enums, then a main.h with the actual variables.  Some
 BP> modules need both, and some don't.

Again in a header file "enum.h" would seem appropriate.

 BP> I also have questions about reusable code, and how to optimally
 BP> split up the files.

Personally, I group related functions together, so that for instance
printer.c contains all the modules to do with printing.

 BP> Anyway, I think it would be time well spent for me to learn more
 BP> about "best practises."

We can only give guidelines based on our experience.

George

--- Terminate 5.00/Pro 
 * Origin: George's Country Point (2:250/501.3)