Penjaga Penyertaan

Header sering menyertakan header lain. Akibatnya, satu header dapat dengan mudah disertakan dua kali dalam berkas sumber yang sama.

Jika itu terjadi, setiap deklarasi di dalamnya muncul dua kali. Untuk definisi tipe seperti struct atau typedef, hal ini merupakan kesalahan kompilasi: sebuah tipe tidak dapat didefinisikan lebih dari satu kali.

Misalkan a.h dan b.h sama-sama menyertakan types.h. Berkas sumber yang menyertakan keduanya akhirnya memiliki salinan types.h dua kali.

Praprosesor menyalin teks header begitu saja, sehingga definisi dalam types.h menjadi duplikat dan memicu kesalahan definisi ulang.

Penjaga penyertaan adalah trik kecil praprosesor yang membuat header aman disertakan berkali-kali.

Penjaga ini membungkus seluruh header dalam kondisi tertentu sehingga isinya hanya diproses pada kali pertama. Penyertaan berikutnya dilewati sepenuhnya.

Saat header pertama kali ditemukan, TYPES_H belum didefinisikan, sehingga #ifndef bernilai benar dan isinya diproses. Kemudian #define menetapkan makro tersebut.

Pada penyertaan berikutnya, TYPES_H sudah ada, sehingga #ifndef bernilai salah dan praprosesor melompat ke #endif.

Berikut contoh header yang realistis dengan penjaga untuk melindungi definisi tipe.

Meskipun banyak berkas menyertakan point.h secara langsung atau tidak langsung, struct Point didefinisikan tepat satu kali untuk setiap unit translasi.

Makro penjaga harus unik di seluruh proyek Anda, jika tidak, dua header dapat berbenturan dan diam-diam saling menyembunyikan.

Konvensi yang umum adalah membentuk nama dari nama berkas dalam huruf besar: point.h menjadi POINT_H, sedangkan net/socket.h menjadi NET_SOCKET_H.

Pengenal yang diawali garis bawah diikuti huruf kapital, atau yang mengandung garis bawah ganda, dicadangkan untuk kompilator dan pustaka standar.

Hindari penjaga seperti __POINT_H__. Bentuk biasa dengan garis bawah di akhir seperti POINT_H aman dan jelas.

Sebagian besar kompilator modern mendukung #pragma once, yaitu satu baris di bagian atas header yang melakukan tugas yang sama.

Bentuk ini lebih singkat dan menghindari benturan nama, tetapi bukan bagian dari standar C. Penjaga #ifndef tradisional dapat digunakan di mana saja.

Penjaga #ifndef sepenuhnya portabel dan standar, tetapi memerlukan makro unik untuk setiap header.

#pragma once ringkas dan bebas benturan, tetapi bergantung pada dukungan kompilator. Beberapa proyek menggunakan keduanya: pragma dan penjaga klasik untuk keamanan maksimum.

Penjaga penyertaan mencegah penyertaan ganda dalam satu berkas sumber saat berkas tersebut dikompilasi.

Penjaga ini tidak mencegah sebuah header diproses satu kali di setiap berkas .c yang terpisah. Hal itu wajar karena setiap berkas sumber merupakan unit translasi yang berbeda.

Tambahkan penjaga penyertaan ke setiap header yang Anda tulis, mulai dari baris pertama. Penjaga ini hanya memerlukan tiga baris dan mencegah banyak kesalahan membingungkan.

Bahkan header sederhana nantinya dapat disertakan secara tidak langsung melalui header lain, sehingga memasang penjaga sejak awal menghemat masalah.

Periksa pemahaman Anda tentang penjaga penyertaan.

Anda telah mempelajari alasan penyertaan header dua kali menyebabkan kesalahan definisi ulang dan cara penjaga penyertaan mencegahnya.

Gunakan #ifndef/#define/#endif dengan makro unik, atau #pragma once. Selanjutnya kita akan melihat cara berbagi variabel antarberkas dengan extern.