foch 0.0.2

EU4 mod analysis and merge toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Crate-private adapter seam for structural merge implementations.

mod address_patch;
mod gumtree_pcs_nway;

use std::path::Path;

use crate::game::eu4::content::DuplicateDefinitionPolicy;

use super::output::materialize::{
	StructuralMergeContext, StructuralMergeFailure, StructuralMergeOutput,
};
use super::planning::module_view::CrossFileModuleViews;
use super::resolution::conflict_handler::ConflictHandler;
use crate::input::ResolvedInputContributor;
use crate::model::GamePath;

pub(crate) use super::kernel_adapter::{MergeBackendDescriptor, MergeBackendId};
pub(crate) use address_patch::AddressPatchBackend;
pub(crate) use gumtree_pcs_nway::GumtreePcsNwayBackend;

#[derive(Clone, Copy, Debug)]
pub(crate) struct BackendProfile {
	pub validate_semantic_units: bool,
	pub duplicate_definition_override: Option<DuplicateDefinitionPolicy>,
}

pub(crate) enum BackendUnit<'a> {
	File(&'a [ResolvedInputContributor]),
	DefinitionModule(&'a CrossFileModuleViews),
}

pub(crate) struct BackendRequest<'data, 'handler> {
	pub target_path: &'data GamePath,
	pub unit: BackendUnit<'data>,
	pub context: StructuralMergeContext<'data>,
	pub interactive_handler: Option<&'handler mut (dyn ConflictHandler + 'static)>,
	pub interactive_config_path: Option<&'data Path>,
}

pub(crate) type BackendOutcome = Result<StructuralMergeOutput, StructuralMergeFailure>;

/// Backends are shared by the threads that analyze merge units concurrently.
pub(crate) trait MergeBackend: Send + Sync {
	fn descriptor(&self) -> MergeBackendDescriptor;
	fn profile(&self) -> BackendProfile;
	fn analyze(&self, request: BackendRequest<'_, '_>) -> BackendOutcome;
}

pub(crate) fn backend_for(id: MergeBackendId) -> Box<dyn MergeBackend> {
	let backend: Box<dyn MergeBackend> = match id {
		MergeBackendId::GumtreePcsNway => Box::new(GumtreePcsNwayBackend),
		MergeBackendId::AddressPatch => Box::new(AddressPatchBackend),
	};
	debug_assert_eq!(backend.descriptor().id, id);
	backend
}

#[cfg(test)]
mod tests {
	use super::{MergeBackendId, backend_for};

	#[test]
	fn backend_factory_preserves_stable_identity_and_maturity() {
		let stable = backend_for(MergeBackendId::default()).descriptor();
		assert_eq!(stable.id, MergeBackendId::GumtreePcsNway);
		assert_eq!(stable.id.as_str(), "gumtree-pcs-nway");
		assert!(!stable.experimental);

		let experimental = backend_for(MergeBackendId::AddressPatch).descriptor();
		assert_eq!(experimental.id.as_str(), "address-patch");
		assert!(experimental.experimental);
	}
}