[MISC] Macro comments: SEQAN3_HAS_BZIP2

eseiler · eseiler · commit 01cbc83fdc9e · 2025-02-24T15:18:13.000+01:00
diff --git a/include/seqan3/io/detail/misc_input.hpp b/include/seqan3/io/detail/misc_input.hpp
@@ -145,7 +145,7 @@ inline auto make_secondary_istream(std::basic_istream<char_t> & primary_stream,
         return {new contrib::basic_bz2_istream<char_t>{primary_stream}, stream_deleter_default};
 #else
         throw file_open_error{"Trying to read from a bzipped file, but no libbz2 available."};
-#endif
+#endif // SEQAN3_HAS_BZIP2
     }
     else if (starts_with(magic_number, zstd_compression::magic_header)) // ZStd
     {
diff --git a/include/seqan3/io/detail/misc_output.hpp b/include/seqan3/io/detail/misc_output.hpp
@@ -73,7 +73,7 @@ inline auto make_secondary_ostream(std::basic_ostream<char_t> & primary_stream,
         return {new contrib::basic_bz2_ostream<char_t>{primary_stream}, stream_deleter_default};
 #else
         throw file_open_error{"Trying to write a bzipped file, but no libbz2 available."};
-#endif
+#endif // SEQAN3_HAS_BZIP2
     }
     else if (extension == ".zst")
     {
diff --git a/test/performance/io/stream_input_benchmark.cpp b/test/performance/io/stream_input_benchmark.cpp
@@ -25,7 +25,7 @@
 #if SEQAN3_HAS_BZIP2
 #    include <seqan3/contrib/stream/bz2_istream.hpp>
 #    include <seqan3/contrib/stream/bz2_ostream.hpp>
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // SEQAN2
 #if __has_include(<seqan/stream.h>)
@@ -37,7 +37,7 @@
 
 #    if SEQAN3_HAS_BZIP2
 #        define SEQAN_HAS_BZIP2 1
-#    endif
+#    endif // SEQAN3_HAS_BZIP2
 
 #    include <seqan/stream.h>
 #endif
@@ -114,7 +114,7 @@ std::string const input_comp<seqan3::contrib::bz2_istream>{
 template <>
 std::string const & input_comp<seqan2::BZ2File> = input_comp<seqan3::contrib::bz2_istream>;
 #    endif
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  plain benchmark of ostringstream
@@ -173,7 +173,7 @@ BENCHMARK_TEMPLATE(compressed, seqan3::contrib::bgzf_istream);
 
 #if SEQAN3_HAS_BZIP2
 BENCHMARK_TEMPLATE(compressed, seqan3::contrib::bz2_istream);
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  compression applied, but stuffed into plain istream
@@ -207,7 +207,7 @@ BENCHMARK_TEMPLATE(compressed_type_erased, seqan3::contrib::bgzf_istream);
 #endif // SEQAN3_HAS_ZLIB
 #if SEQAN3_HAS_BZIP2
 BENCHMARK_TEMPLATE(compressed_type_erased, seqan3::contrib::bz2_istream);
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  compression applied, but stuffed into plain istream, also stringstream erased
@@ -241,7 +241,7 @@ BENCHMARK_TEMPLATE(compressed_type_erased2, seqan3::contrib::bgzf_istream);
 #endif // SEQAN3_HAS_ZLIB
 #if SEQAN3_HAS_BZIP2
 BENCHMARK_TEMPLATE(compressed_type_erased2, seqan3::contrib::bz2_istream);
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  seqan2 virtual stream
diff --git a/test/performance/io/stream_output_benchmark.cpp b/test/performance/io/stream_output_benchmark.cpp
@@ -15,7 +15,7 @@
 
 #if SEQAN3_HAS_BZIP2
 #    include <seqan3/contrib/stream/bz2_ostream.hpp>
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // SEQAN2
 #if __has_include(<seqan/stream.h>)
@@ -27,7 +27,7 @@
 
 #    if SEQAN3_HAS_BZIP2
 #        define SEQAN_HAS_BZIP2 1
-#    endif
+#    endif // SEQAN3_HAS_BZIP2
 
 #    include <seqan/stream.h>
 #endif
@@ -72,7 +72,7 @@ BENCHMARK_TEMPLATE(compressed, seqan3::contrib::bgzf_ostream);
 #endif // SEQAN3_HAS_ZLIB
 #if SEQAN3_HAS_BZIP2
 BENCHMARK_TEMPLATE(compressed, seqan3::contrib::bz2_ostream);
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  compression applied, but stuffed into plain ostream
@@ -98,7 +98,7 @@ BENCHMARK_TEMPLATE(compressed_type_erased, seqan3::contrib::bgzf_ostream);
 #endif // SEQAN3_HAS_ZLIB
 #if SEQAN3_HAS_BZIP2
 BENCHMARK_TEMPLATE(compressed_type_erased, seqan3::contrib::bz2_ostream);
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  compression applied, but stuffed into plain ostream, also stringstream erased
@@ -124,7 +124,7 @@ BENCHMARK_TEMPLATE(compressed_type_erased2, seqan3::contrib::bgzf_ostream);
 #endif // SEQAN3_HAS_ZLIB
 #if SEQAN3_HAS_BZIP2
 BENCHMARK_TEMPLATE(compressed_type_erased2, seqan3::contrib::bz2_ostream);
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ============================================================================
 //  seqan2 virtual stream
diff --git a/test/unit/contrib/stream/bz2_istream_test.cpp b/test/unit/contrib/stream/bz2_istream_test.cpp
@@ -37,4 +37,4 @@ TEST(bz2_istream_test, skipped)
     GTEST_SKIP() << "BZip2 is missing. Not running bz2_istream_test.";
 }
 
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/contrib/stream/bz2_ostream_test.cpp b/test/unit/contrib/stream/bz2_ostream_test.cpp
@@ -37,4 +37,4 @@ TEST(bz2_ostream_test, skipped)
     GTEST_SKIP() << "BZip2 is missing. Not running bz2_ostream_test.";
 }
 
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/io/detail/magic_header_test.cpp b/test/unit/io/detail/magic_header_test.cpp
@@ -23,7 +23,7 @@ TEST(misc, valid_compression_extensions)
 
 #if SEQAN3_HAS_BZIP2
     EXPECT_TRUE(std::find(valid_compression.begin(), valid_compression.end(), "bz2") != valid_compression.end());
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 #if defined(SEQAN3_HAS_ZSTD)
     EXPECT_TRUE(std::find(valid_compression.begin(), valid_compression.end(), "zst") != valid_compression.end());
diff --git a/test/unit/io/detail/misc_output_test.cpp b/test/unit/io/detail/misc_output_test.cpp
@@ -61,4 +61,4 @@ TEST(misc_output, issue2455_bz)
 
     EXPECT_TRUE(seqan3::detail::starts_with(file_content, seqan3::detail::bz2_compression::magic_header));
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/io/sam_file/sam_file_input_test.cpp b/test/unit/io/sam_file/sam_file_input_test.cpp
@@ -483,7 +483,7 @@ TEST_F(sam_file_input_f, read_empty_bz2_file)
 
     EXPECT_TRUE(fin.begin() == fin.end());
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2
 
 // ----------------------------------------------------------------------------
 // BAM format specificities
diff --git a/test/unit/io/sam_file/sam_file_output_test.cpp b/test/unit/io/sam_file/sam_file_output_test.cpp
@@ -777,4 +777,4 @@ TEST(compression, by_stream_bz2)
 
     EXPECT_EQ(out.str(), expected_bz2);
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/io/sequence_file/sequence_file_input_test.cpp b/test/unit/io/sequence_file/sequence_file_input_test.cpp
@@ -466,4 +466,4 @@ TEST_F(sequence_file_input_f, read_empty_bz2_file)
 
     EXPECT_TRUE(fin.begin() == fin.end());
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/io/sequence_file/sequence_file_output_test.cpp b/test/unit/io/sequence_file/sequence_file_output_test.cpp
@@ -561,4 +561,4 @@ TEST(compression, by_stream_bz2)
 
     EXPECT_EQ(out.str(), expected_bz2);
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/io/structure_file/structure_file_input_test.cpp b/test/unit/io/structure_file/structure_file_input_test.cpp
@@ -534,4 +534,4 @@ TEST_F(structure_file_input_read, read_empty_bz2_file)
 
     EXPECT_TRUE(fin.begin() == fin.end());
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2
diff --git a/test/unit/io/structure_file/structure_file_output_test.cpp b/test/unit/io/structure_file/structure_file_output_test.cpp
@@ -550,4 +550,4 @@ TEST_F(structure_file_output_compression, by_stream_bz2)
     }
     EXPECT_EQ(out.str(), expected_bz2);
 }
-#endif
+#endif // SEQAN3_HAS_BZIP2

Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ inline auto make_secondary_istream(std::basic_istream<char_t> & primary_stream,`
`145`	`145`	`return {new contrib::basic_bz2_istream<char_t>{primary_stream}, stream_deleter_default};`
`146`	`146`	`#else`
`147`	`147`	`throw file_open_error{"Trying to read from a bzipped file, but no libbz2 available."};`
`148`		`-#endif`
	`148`	`+#endif // SEQAN3_HAS_BZIP2`
`149`	`149`	`}`
`150`	`150`	`else if (starts_with(magic_number, zstd_compression::magic_header)) // ZStd`
`151`	`151`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ inline auto make_secondary_ostream(std::basic_ostream<char_t> & primary_stream,`
`73`	`73`	`return {new contrib::basic_bz2_ostream<char_t>{primary_stream}, stream_deleter_default};`
`74`	`74`	`#else`
`75`	`75`	`throw file_open_error{"Trying to write a bzipped file, but no libbz2 available."};`
`76`		`-#endif`
	`76`	`+#endif // SEQAN3_HAS_BZIP2`
`77`	`77`	`}`
`78`	`78`	`else if (extension == ".zst")`
`79`	`79`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,4 @@ TEST(bz2_istream_test, skipped)`
`37`	`37`	`GTEST_SKIP() << "BZip2 is missing. Not running bz2_istream_test.";`
`38`	`38`	`}`
`39`	`39`
`40`		`-#endif`
	`40`	`+#endif // SEQAN3_HAS_BZIP2`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,4 @@ TEST(bz2_ostream_test, skipped)`
`37`	`37`	`GTEST_SKIP() << "BZip2 is missing. Not running bz2_ostream_test.";`
`38`	`38`	`}`
`39`	`39`
`40`		`-#endif`
	`40`	`+#endif // SEQAN3_HAS_BZIP2`
Original file line number	Diff line number	Diff line change
`@@ -61,4 +61,4 @@ TEST(misc_output, issue2455_bz)`
`61`	`61`
`62`	`62`	`EXPECT_TRUE(seqan3::detail::starts_with(file_content, seqan3::detail::bz2_compression::magic_header));`
`63`	`63`	`}`
`64`		`-#endif`
	`64`	`+#endif // SEQAN3_HAS_BZIP2`
Original file line number	Diff line number	Diff line change
`@@ -483,7 +483,7 @@ TEST_F(sam_file_input_f, read_empty_bz2_file)`
`483`	`483`
`484`	`484`	`EXPECT_TRUE(fin.begin() == fin.end());`
`485`	`485`	`}`
`486`		`-#endif`
	`486`	`+#endif // SEQAN3_HAS_BZIP2`
`487`	`487`
`488`	`488`	`// ----------------------------------------------------------------------------`
`489`	`489`	`// BAM format specificities`
Original file line number	Diff line number	Diff line change
`@@ -777,4 +777,4 @@ TEST(compression, by_stream_bz2)`
`777`	`777`
`778`	`778`	`EXPECT_EQ(out.str(), expected_bz2);`
`779`	`779`	`}`
`780`		`-#endif`
	`780`	`+#endif // SEQAN3_HAS_BZIP2`