Apakah lebih baik untuk menentukan file sumber dengan GLOB atau setiap file secara individual di CMake?

CMake menawarkan beberapa cara untuk menentukan file sumber untuk target. Salah satunya adalah menggunakan globbing ( dokumentasi ), misalnya:

FILE(GLOB MY_SRCS dir/*)

Metode lain adalah menentukan setiap file secara individual.

Cara mana yang lebih disukai? Globbing sepertinya mudah, tetapi saya dengar ada beberapa kelemahan.

Pengungkapan penuh: Saya awalnya lebih suka pendekatan globbing karena kesederhanaannya, tetapi selama bertahun-tahun saya menyadari bahwa secara eksplisit daftar file tidak terlalu rentan kesalahan untuk proyek-proyek besar, multi-developer.

Jawaban asli:

Keuntungan dari globbing adalah:

• Sangat mudah untuk menambahkan file baru karena hanya terdaftar di satu tempat: pada disk. Tidak globbing menciptakan duplikasi.

• File CMakeLists.txt Anda akan lebih pendek. Ini merupakan nilai tambah besar jika Anda memiliki banyak file. Tidak menggumpal menyebabkan Anda kehilangan logika CMake di antara daftar besar file.

Keuntungan menggunakan daftar file hardcoded adalah:

• CMake akan melacak dependensi file baru pada disk dengan benar - jika kita menggunakan glob maka file tidak menggumpal pertama kali ketika Anda menjalankan CMake tidak akan diambil

• Anda memastikan bahwa hanya file yang Anda inginkan yang ditambahkan. Globbing dapat mengambil file liar yang tidak Anda inginkan.

Untuk mengatasi masalah pertama, Anda cukup "menyentuh" ​​CMakeLists.txt yang melakukan glob, baik dengan menggunakan perintah sentuh atau dengan menulis file tanpa perubahan. Ini akan memaksa CMake untuk menjalankan kembali dan mengambil file baru.

Untuk memperbaiki masalah kedua, Anda dapat mengatur kode Anda dengan hati-hati ke dalam direktori, yang mungkin Anda lakukan. Dalam kasus terburuk, Anda dapat menggunakan list(REMOVE_ITEM)perintah untuk membersihkan daftar berkas globbed:

file(GLOB to_remove file_to_remove.cpp)
list(REMOVE_ITEM list ${to_remove})

Satu-satunya situasi nyata di mana ini dapat menggigit Anda adalah jika Anda menggunakan sesuatu seperti git-bisect untuk mencoba versi kode Anda yang lebih lama di direktori build yang sama. Dalam hal ini, Anda mungkin harus membersihkan dan mengkompilasi lebih dari yang diperlukan untuk memastikan Anda mendapatkan file yang tepat dalam daftar. Ini adalah kasus sudut, dan di mana Anda sudah berada di kaki Anda, bahwa itu tidak benar-benar masalah.

Cara terbaik untuk menentukan sourcefile di CMake adalah dengan mendaftar secara eksplisit .

Pembuat CMake sendiri menyarankan untuk tidak menggunakan globbing.

Lihat: https://cmake.org/cmake/help/v3.15/command/file.html?highlight=glob#file

(Kami tidak menyarankan menggunakan GLOB untuk mengumpulkan daftar file sumber dari hierarki sumber Anda. Jika tidak ada file CMakeLists.txt yang berubah ketika sumber ditambahkan atau dihapus, sistem build yang dihasilkan tidak tahu kapan harus meminta CMake untuk membuat ulang.)

Tentu saja, Anda mungkin ingin tahu apa kerugiannya - baca terus!

Ketika Globbing Gagal:

Kerugian besar dari globbing adalah membuat / menghapus file tidak akan secara otomatis memperbarui sistem build.

Jika Anda adalah orang yang menambahkan file, ini mungkin merupakan trade-off yang dapat diterima, namun hal ini menyebabkan masalah bagi orang lain yang membangun kode Anda, mereka memperbarui proyek dari kontrol versi, menjalankan build, kemudian menghubungi Anda, mengeluh bahwa
"build's rusak".

Untuk membuat keadaan menjadi lebih buruk, kegagalan biasanya memberikan beberapa kesalahan penghubung yang tidak memberikan petunjuk apa pun tentang penyebab masalah dan waktu hilang pemecahan masalah itu.

Dalam sebuah proyek yang saya kerjakan, kami memulai globbing tetapi mendapat begitu banyak keluhan ketika file baru ditambahkan, bahwa itu adalah alasan yang cukup untuk secara eksplisit mendaftar file daripada globbing.

Ini juga memecah alur kerja git yang umum
( git bisectdan beralih di antara cabang fitur).

Jadi saya tidak bisa merekomendasikan ini, masalah yang disebabkannya jauh melebihi kenyamanan, ketika seseorang tidak dapat membangun perangkat lunak Anda karena ini, mereka mungkin kehilangan banyak waktu untuk melacak masalah atau menyerah begitu saja.

Dan catatan lain, Hanya ingat untuk menyentuh CMakeLists.txttidak selalu cukup, dengan build otomatis yang menggunakan globbing, saya harus menjalankan cmakesebelum setiap build karena file mungkin telah ditambahkan / dihapus sejak bangunan terakhir *.

Pengecualian terhadap aturan:

Ada saat-saat globbing lebih disukai:

• Untuk mengatur CMakeLists.txtfile untuk proyek yang ada yang tidak menggunakan CMake.
  Ini cara cepat untuk mendapatkan semua sumber yang direferensikan (setelah sistem build berjalan - ganti globbing dengan daftar file yang eksplisit).
• Ketika CMake tidak digunakan sebagai sistem build utama , jika misalnya Anda menggunakan proyek yang tidak menggunakan CMake, dan Anda ingin mempertahankan sistem build Anda sendiri untuk itu.
• Untuk setiap situasi di mana daftar file berubah begitu sering sehingga menjadi tidak praktis untuk dipelihara. Dalam hal ini bisa berguna, tetapi kemudian Anda harus menerima menjalankan cmakeuntuk menghasilkan file-file build setiap kali untuk mendapatkan build yang andal / benar (yang bertentangan dengan niat CMake - kemampuan untuk memisahkan konfigurasi dari gedung) .

* Ya, saya bisa menulis kode untuk membandingkan pohon file pada disk sebelum dan sesudah pembaruan, tetapi ini bukan solusi yang baik dan sesuatu yang lebih baik diserahkan kepada sistem build.

Dalam CMake 3.12, perintah file(GLOB ...)danfile(GLOB_RECURSE ...) memperoleh CONFIGURE_DEPENDSopsi yang menjalankan kembali cmake jika nilai glob berubah. Karena itu adalah kelemahan utama dari globbing untuk file sumber, sekarang boleh saja melakukannya:

# Whenever this glob's value changes, cmake will rerun and update the build with the
# new/removed files.
file(GLOB_RECURSE sources CONFIGURE_DEPENDS "*.cpp")

add_executable(my_target ${sources})

Namun, beberapa orang masih merekomendasikan menghindari globbing untuk sumber. Memang, dokumentasi menyatakan:

Kami tidak menyarankan menggunakan GLOB untuk mengumpulkan daftar file sumber dari pohon sumber Anda. ... CONFIGURE_DEPENDSBendera mungkin tidak berfungsi dengan baik pada semua generator, atau jika generator baru ditambahkan di masa depan yang tidak dapat mendukungnya, proyek yang menggunakannya akan macet. Bahkan jika CONFIGURE_DEPENDSbekerja dengan andal, masih ada biaya untuk melakukan pemeriksaan pada setiap pembangunan kembali.

Secara pribadi, saya menganggap manfaat dari tidak harus mengelola secara manual daftar file sumber untuk lebih besar daripada kemungkinan kelemahannya. Jika Anda harus beralih kembali ke file yang terdaftar secara manual, ini dapat dengan mudah dicapai dengan hanya mencetak daftar sumber globbed dan menempelkannya kembali.

Anda dapat dengan aman glob (dan mungkin harus) dengan mengorbankan file tambahan untuk menahan dependensi.

Tambahkan fungsi seperti ini di suatu tempat:

# Compare the new contents with the existing file, if it exists and is the 
# same we don't want to trigger a make by changing its timestamp.
function(update_file path content)
    set(old_content "")
    if(EXISTS "${path}")
        file(READ "${path}" old_content)
    endif()
    if(NOT old_content STREQUAL content)
        file(WRITE "${path}" "${content}")
    endif()
endfunction(update_file)

# Creates a file called CMakeDeps.cmake next to your CMakeLists.txt with
# the list of dependencies in it - this file should be treated as part of 
# CMakeLists.txt (source controlled, etc.).
function(update_deps_file deps)
    set(deps_file "CMakeDeps.cmake")
    # Normalize the list so it's the same on every machine
    list(REMOVE_DUPLICATES deps)
    foreach(dep IN LISTS deps)
        file(RELATIVE_PATH rel_dep ${CMAKE_CURRENT_SOURCE_DIR} ${dep})
        list(APPEND rel_deps ${rel_dep})
    endforeach(dep)
    list(SORT rel_deps)
    # Update the deps file
    set(content "# generated by make process\nset(sources ${rel_deps})\n")
    update_file(${deps_file} "${content}")
    # Include the file so it's tracked as a generation dependency we don't
    # need the content.
    include(${deps_file})
endfunction(update_deps_file)

Dan kemudian pergi globbing:

file(GLOB_RECURSE sources LIST_DIRECTORIES false *.h *.cpp)
update_deps_file("${sources}")
add_executable(test ${sources})

Anda masih menggunakan dependensi eksplisit (dan memicu semua build otomatis!) Seperti sebelumnya, hanya saja dalam dua file, bukan satu.

Satu-satunya perubahan dalam prosedur adalah setelah Anda membuat file baru. Jika Anda tidak glob, alur kerjanya adalah memodifikasi CMakeLists.txt dari dalam Visual Studio dan membangun kembali, jika Anda melakukan glob, Anda menjalankan cmake secara eksplisit - atau cukup sentuh CMakeLists.txt.

Tentukan setiap file secara individual!

Saya menggunakan CMakeLists.txt konvensional dan skrip python untuk memperbaruinya. Saya menjalankan skrip python secara manual setelah menambahkan file.

Lihat jawaban saya di sini: https://stackoverflow.com/a/48318388/3929196