#include in .h o .c/.cpp?

Question

Durante la codifica in C o C++, dove dovrei avere lo #include?

callback.h:

#ifndef _CALLBACK_H_ 
#define _CALLBACK_H_ 

#include <sndfile.h> 
#include "main.h" 

void on_button_apply_clicked(GtkButton* button, struct user_data_s* data); 
void on_button_cancel_clicked(GtkButton* button, struct user_data_s* data); 

#endif 

callback.c:

#include <stdlib.h> 
#include <math.h> 

#include "config.h" 

#include "callback.h" 
#include "play.h" 

void on_button_apply_clicked(GtkButton* button, struct user_data_s* data) { 
    gint page; 
    page = gtk_notebook_get_current_page(GTK_NOTEBOOK(data->notebook)); 

    ... 

caso tutti comprende essere sia nel .h o .c/cpp, o entrambi, come ho fatto io qui?

Answer 1

Inserire il più possibile nello .c e il meno possibile nello .h. Gli include nello .c sono inclusi solo quando viene compilato quel file, ma gli include per lo .h devono essere inclusi da ogni file che lo utilizza.

Answer 2

Se I #include <callback.h>, non voglio avere #include molti altri file di intestazione per ottenere il mio codice da compilare. In callback.h dovresti includere tutto ciò che è necessario per compilare. Ma niente di più.

Considerare se utilizzare le dichiarazioni di inoltro nel file di intestazione (ad esempio class GtkButton;) sarà sufficiente, consentendo di ridurre il numero di direttive #include nell'intestazione (e, a sua volta, il tempo e la complessità della compilazione).

Answer 3

Metti il ​​maggior numero di include nel tuo cpp possibile e solo quelli che sono necessari nel file hpp nell'hpp. Credo che ciò contribuirà ad accelerare la compilazione, poiché i file hpp avranno meno riferimenti incrociati.

Considerare inoltre l'utilizzo di forward declarations nel file hpp per ridurre ulteriormente la catena di dipendenze di inclusione.

Answer 4

L'unica volta che è necessario includere un'intestazione all'interno di un altro file .h è se è necessario accedere a una definizione di tipo in tale intestazione; ad esempio:

#ifndef MY_HEADER_H 
#define MY_HEADER_H 

#include <stdio.h> 

void doStuffWith(FILE *f); // need the definition of FILE from stdio.h 

#endif 

Se intestazione A dipende intestazione B, come nell'esempio precedente, allora A deve includere intestazione intestazione B direttamente. Do NON prova ad ordinare il tuo include nel file .c per soddisfare le dipendenze (cioè, includendo l'intestazione B prima dell'intestazione A); questo è un grosso mucchio di bruciore di stomaco che aspetta di accadere. Voglio dire che. Sono stato in quel film diverse volte, e si è sempre concluso con Tokyo in fiamme.

Sì, questo può causare l'inclusione di file più volte, ma se dispongono di protezioni di inclusione appropriate impostate per proteggere da più errori di dichiarazione/definizione, non vale la pena preoccuparsi di alcuni secondi extra di tempo di costruzione. Cercare di gestire le dipendenze manualmente è un rompicapo.

Ovviamente, non dovresti includere file in cui non è necessario a.