OpenSSF silver badge: minor refactor C API implementation

[mgovers]

Cherry-picked changes from #1264

Re-opened a new PR as #1264 was superceded by #1266.

This PR is also rebased off main rather than #1241 to allow easier development.

[TonyXiang8787]

Since we are here, please fix the additional problems in the dataset pointer check. Namely for the attribute pointers.

power-grid-model/power_grid_model_c/power_grid_model_c/src/dataset.cpp

Lines 131 to 137 in b951eff

	void PGM_dataset_const_add_attribute_buffer(PGM_Handle* handle, PGM_ConstDataset* dataset, char const* component,
	char const* attribute, void const* data) {
	call_with_catch(handle, [dataset, component, attribute, data] {
	safe_ptr_get(cast_to_cpp(dataset))
	.add_attribute_buffer(safe_str_view(component), safe_str_view(attribute), safe_ptr(data));
	});
	}

power-grid-model/power_grid_model_c/power_grid_model_c/src/dataset.cpp

Lines 165 to 171 in b951eff

	void PGM_dataset_writable_set_attribute_buffer(PGM_Handle* handle, PGM_WritableDataset* dataset, char const* component,
	char const* attribute, void* data) {
	call_with_catch(handle, [dataset, component, attribute, data] {
	safe_ptr_get(cast_to_cpp(dataset))
	.set_attribute_buffer(safe_str_view(component), safe_str_view(attribute), safe_ptr(data));
	});
	}

power-grid-model/power_grid_model_c/power_grid_model_c/src/dataset.cpp

Lines 197 to 203 in b951eff

	void PGM_dataset_mutable_add_attribute_buffer(PGM_Handle* handle, PGM_MutableDataset* dataset, char const* component,
	char const* attribute, void* data) {
	call_with_catch(handle, [dataset, component, attribute, data] {
	safe_ptr_get(cast_to_cpp(dataset))
	.add_attribute_buffer(safe_str_view(component), safe_str_view(attribute), safe_ptr(data));
	});
	}

These data pointers should be allowed to be nullptr, if the total number of the elements in the component is zero. Users may still create such an attribute buffer (e.g. empyt vector or empty span, or empty numpy array) in an automatic way. But the data pointer maybe nullptr which is well defined.

[mgovers]

Since we are here, please fix the additional problems in the dataset pointer check. Namely for the attribute pointers.

power-grid-model/power_grid_model_c/power_grid_model_c/src/dataset.cpp

Lines 131 to 137 in b951eff

	void PGM_dataset_const_add_attribute_buffer(PGM_Handle* handle, PGM_ConstDataset* dataset, char const* component,
	char const* attribute, void const* data) {
	call_with_catch(handle, [dataset, component, attribute, data] {
	safe_ptr_get(cast_to_cpp(dataset))
	.add_attribute_buffer(safe_str_view(component), safe_str_view(attribute), safe_ptr(data));
	});
	}

power-grid-model/power_grid_model_c/power_grid_model_c/src/dataset.cpp

Lines 165 to 171 in b951eff

	void PGM_dataset_writable_set_attribute_buffer(PGM_Handle* handle, PGM_WritableDataset* dataset, char const* component,
	char const* attribute, void* data) {
	call_with_catch(handle, [dataset, component, attribute, data] {
	safe_ptr_get(cast_to_cpp(dataset))
	.set_attribute_buffer(safe_str_view(component), safe_str_view(attribute), safe_ptr(data));
	});
	}

power-grid-model/power_grid_model_c/power_grid_model_c/src/dataset.cpp

Lines 197 to 203 in b951eff

	void PGM_dataset_mutable_add_attribute_buffer(PGM_Handle* handle, PGM_MutableDataset* dataset, char const* component,
	char const* attribute, void* data) {
	call_with_catch(handle, [dataset, component, attribute, data] {
	safe_ptr_get(cast_to_cpp(dataset))
	.add_attribute_buffer(safe_str_view(component), safe_str_view(attribute), safe_ptr(data));
	});
	}

These data pointers should be allowed to be nullptr, if the total number of the elements in the component is zero. Users may still create such an attribute buffer (e.g. empyt vector or empty span, or empty numpy array) in an automatic way. But the data pointer maybe nullptr which is well defined.

i am implementing that as we speak but it is something we really want to allow? currently, it will introduce segmentation violations EDIT: my test was incorrect. it works as intended

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud