Add algorithm_hint inherent feature

Author: twistedfall

build.rs

@@ -6,6 +6,7 @@ use std::time::Instant;
 
 use binding_generator::handle_running_binding_generator;
 use docs::handle_running_in_docsrs;
+use enums::{InherentFeature, SUPPORTED_INHERENT_FEATURES, SUPPORTED_MODULES};
 use generator::BindingGenerator;
 use header::IncludePath;
 use library::Library;
@@ -19,6 +20,8 @@ mod binding_generator;
 pub mod cmake_probe;
 #[path = "build/docs.rs"]
 mod docs;
+#[path = "build/enums.rs"]
+mod enums;
 #[path = "build/generator.rs"]
 mod generator;
 #[path = "build/header.rs"]
@@ -63,84 +66,6 @@ static AFFECTING_ENV_VARS: [&str; 18] = [
 
 static SUPPORTED_OPENCV_BRANCHES: [(&str, &str); 3] = [("~3.4", "34"), ("~4", "4"), ("~5", "5")];
 
-static SUPPORTED_MODULES: [SupportedModule; 73] = [
-	SupportedModule::ThreeD,
-	SupportedModule::AlphaMat,
-	SupportedModule::Aruco,
-	SupportedModule::ArucoDetector,
-	SupportedModule::Barcode,
-	SupportedModule::BgSegm,
-	SupportedModule::Bioinspired,
-	SupportedModule::Calib,
-	SupportedModule::Calib3d,
-	SupportedModule::CCalib,
-	SupportedModule::Core,
-	SupportedModule::CudaArithm,
-	SupportedModule::CudaBgSegm,
-	SupportedModule::CudaCodec,
-	SupportedModule::CudaFeatures2d,
-	SupportedModule::CudaFilters,
-	SupportedModule::CudaImgProc,
-	SupportedModule::CudaLegacy,
-	SupportedModule::CudaObjDetect,
-	SupportedModule::CudaOptFlow,
-	SupportedModule::CudaStereo,
-	SupportedModule::CudaWarping,
-	SupportedModule::Cvv,
-	SupportedModule::Dnn,
-	SupportedModule::DnnSuperRes,
-	SupportedModule::Dpm,
-	SupportedModule::Face,
-	SupportedModule::Features,
-	SupportedModule::Features2d,
-	SupportedModule::Flann,
-	SupportedModule::Freetype,
-	SupportedModule::Fuzzy,
-	SupportedModule::Gapi,
-	SupportedModule::Hdf,
-	SupportedModule::Hfs,
-	SupportedModule::HighGui,
-	SupportedModule::ImgHash,
-	SupportedModule::ImgCodecs,
-	SupportedModule::ImgProc,
-	SupportedModule::IntensityTransform,
-	SupportedModule::LineDescriptor,
-	SupportedModule::Mcc,
-	SupportedModule::Ml,
-	SupportedModule::ObjDetect,
-	SupportedModule::OptFlow,
-	SupportedModule::Ovis,
-	SupportedModule::PhaseUnwrapping,
-	SupportedModule::Photo,
-	SupportedModule::Plot,
-	SupportedModule::Quality,
-	SupportedModule::Rapid,
-	SupportedModule::Rgbd,
-	SupportedModule::Saliency,
-	SupportedModule::Sfm,
-	SupportedModule::Shape,
-	SupportedModule::Signal,
-	SupportedModule::Stereo,
-	SupportedModule::Stitching,
-	SupportedModule::StructuredLight,
-	SupportedModule::SuperRes,
-	SupportedModule::SurfaceMatching,
-	SupportedModule::Text,
-	SupportedModule::Tracking,
-	SupportedModule::Video,
-	SupportedModule::VideoIo,
-	SupportedModule::VideoStab,
-	SupportedModule::Viz,
-	SupportedModule::WechatQrCode,
-	SupportedModule::XFeatures2d,
-	SupportedModule::XImgProc,
-	SupportedModule::XObjDetect,
-	SupportedModule::XPhoto,
-	SupportedModule::XStereo,
-];
-
-static SUPPORTED_INHERENT_FEATURES: [&str; 3] = ["hfloat", "opencl", "cuda"];
-
 /// The contents of these vars will be present in the debug log, but will not cause the source rebuild
 static DEBUG_ENV_VARS: [&str; 1] = ["PATH"];
 
@@ -227,18 +152,23 @@ fn emit_opencv_branch(opencv: &Library) {
 }
 
 fn emit_inherent_features(opencv: &Library) {
+	let mut fake_features = Vec::with_capacity(2);
 	if VersionReq::parse(">=4.10")
 		.expect("Static version requirement")
 		.matches(&opencv.version)
 	{
-		// hfloat is not an actual OpenCV feature specified in the cvconfig.h, but something that's supported starting with 4.10
-		println!("cargo::rustc-cfg=ocvrs_has_inherent_feature_hfloat");
-	}
-	for inherent_feature in &opencv.inherent_features {
-		if SUPPORTED_INHERENT_FEATURES.contains(&inherent_feature.as_str()) {
-			println!("cargo::rustc-cfg=ocvrs_has_inherent_feature_{inherent_feature}");
+		fake_features.push(InherentFeature::Hfloat);
+		if VersionReq::parse(">=4.11")
+			.expect("Static version requirement")
+			.matches(&opencv.version)
+		{
+			fake_features.push(InherentFeature::AlgorithmHint);
 		}
 	}
+	let detected_supported_inherent_features = opencv.inherent_features.iter().flat_map(|f| InherentFeature::try_from_str(f));
+	for inherent_feature in detected_supported_inherent_features.chain(fake_features) {
+		println!("cargo::rustc-cfg=ocvrs_has_inherent_feature_{}", inherent_feature.as_str());
+	}
 }
 
 fn emit_modules(modules: &[SupportedModule]) {
@@ -360,7 +290,10 @@ fn main() -> Result<()> {
 		println!("cargo::rustc-check-cfg=cfg(ocvrs_has_module_{})", module.opencv_name());
 	}
 	for inherent_feature in SUPPORTED_INHERENT_FEATURES {
-		println!("cargo::rustc-check-cfg=cfg(ocvrs_has_inherent_feature_{inherent_feature})");
+		println!(
+			"cargo::rustc-check-cfg=cfg(ocvrs_has_inherent_feature_{})",
+			inherent_feature.as_str()
+		);
 	}
 
 	if matches!(handle_running_in_docsrs(), GenerateFullBindings::Stop) {

build/cond_macros/opencv_branch.rs

@@ -0,0 +1,51 @@
+/// Conditional compilation macro based on OpenCV branch version for usage in external crates.
+///
+/// # Examples
+///
+/// Alternative import:
+/// ```
+/// opencv::not_opencv_branch_34! {
+///     use opencv::imgproc::LINE_8;
+/// }
+/// opencv::opencv_branch_34! {
+///     use opencv::core::LINE_8;
+/// }
+/// ```
+///
+/// Alternative function call:
+/// ```
+/// let mut cam = opencv::opencv_branch_34! {
+///     {
+///         opencv::videoio::VideoCapture::new_default(0)?
+///     } else {
+///         opencv::videoio::VideoCapture::new(0, videoio::CAP_ANY)?
+///     }
+/// };
+/// ```
+#[cfg({{ cfg_condition_prefix }}ocvrs_opencv_branch_{{ feature }}{{ cfg_condition_suffix }})]
+#[macro_export]
+macro_rules! opencv_branch_{{ feature }} {
+	($bl_pos:block else $bl_neg:block) => { {{ macro_body_block }} };
+	($($tt:tt)*) => { {{ macro_body_tt }} }
+}
+
+/// Conditional compilation macro based on OpenCV branch version for usage in external crates.
+///
+/// # Examples
+///
+/// Alternative import:
+/// ```
+/// opencv::not_opencv_branch_34! {
+///     use opencv::imgproc::LINE_8;
+/// }
+/// opencv::opencv_branch_34! {
+///     use opencv::core::LINE_8;
+/// }
+/// ```
+#[cfg({{ cfg_condition_prefix }}ocvrs_opencv_branch_{{ feature }}{{ cfg_condition_suffix }})]
+#[macro_export]
+macro_rules! not_opencv_branch_{{ feature }} {
+	($($tt:tt)*) => { {{ macro_body_not_tt }} }
+}
+
+

build/cond_macros/opencv_branch.tpl.rs

@@ -0,0 +1,35 @@
+/// Conditional compilation macro based on whether OpenCV was built with or without the {{ feature }} feature
+///
+/// The macro has two forms:
+/// 1. Two blocks, separated by the `else` keyword. The first block will be compiled if the OpenCV feature is enabled, the second
+///    one — if it's not. Note that both blocks must have the same return type.
+/// 2. Plain token tree, for usage on the item level, e.g., for `use` imports. The code inside will be compiled if the OpenCV
+///    feature is enabled and completely skipped if it's not.
+///
+/// # Examples
+///
+/// Two blocks with `else`:
+/// ```
+/// let cuda_available = opencv::opencv_has_inherent_feature_cuda! {
+///     {
+///         true
+///     } else {
+///         false
+///     }
+/// };
+/// ```
+///
+/// Plain token tree:
+/// ```
+/// opencv::opencv_has_inherent_feature_cuda! {
+///    use opencv::core::GpuMat;
+/// }
+/// ```
+#[cfg({{ cfg_condition_prefix }}ocvrs_has_inherent_feature_{{ feature }}{{ cfg_condition_suffix }})]
+#[macro_export]
+macro_rules! opencv_has_inherent_feature_{{ feature }} {
+	($bl_pos:block else $bl_neg:block) => { {{ macro_body_block }} };
+	($($tt:tt)*) => { {{ macro_body_tt }} };
+}
+
+