New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make the C API higher level #2650

Open

ferdonline wants to merge 9 commits into api from api-hl

Member

ferdonline commented Jan 6, 2024 •

edited

This PR builds on #2357 and makes the API higher level and easier to use.

It was lightly inspired by Python C Api, namely function/method calls expect all parameters as var-args so the user doesn't mess with the stack.

Scope

Definition of an argument passing format
Make function call use the format and variable number of args
Do error handling

Tests

Unit tests adapted accordingly. Please refer to them to see user facing impact.

ferdonline added 2 commits

January 4, 2024 18:14


          A higher level API for function calls

e0a593b


          Working version of the High Level API

648999e

ferdonline requested review from ramcdougal and pramodk

January 6, 2024 03:27

This comment has been minimized.

Sign in to view


          Cleanup

4c2c120

ferdonline force-pushed the api-hl branch from 830cc9a to 4c2c120 Compare

January 7, 2024 16:10

This comment has been minimized.

Sign in to view


          Documentation and more cleanup

509d520

This comment has been minimized.

Sign in to view

ferdonline requested a review from 1uc

January 7, 2024 21:59

azure-pipelines bot commented Jan 7, 2024

✔️ 509d520 -> Azure artifacts URL


          Address intel compiler complain

b6e4a95

1uc reviewed

View reviewed changes

test/api/netcon.cpp Show resolved Hide resolved


          No more manual stack pop. Methods pop the right type and return Result

dd1569a

azure-pipelines bot commented Jan 9, 2024

✔️ dd1569a -> Azure artifacts URL

This comment has been minimized.

Sign in to view

ferdonline added 2 commits

January 10, 2024 12:31


          Creating catch unit tests for API

d23f891


          Make return value pop its own func. Investigate other internal funcs

37c4ecf

By default Neuron functions return double. However, some internal
functions can retuen also Objects or Strings (STRINGFUNC and OBJECTFUNC)
Unfortuinately those cases are not supported directly and for the moment
we issue a warning.

ferdonline force-pushed the api-hl branch from 37ae189 to 37c4ecf Compare

January 11, 2024 23:09

azure-pipelines bot commented Jan 11, 2024

✔️ 37c4ecf -> Azure artifacts URL

This comment has been minimized.

Sign in to view


          Merge branch 'api' into api-hl

deb29fb

Conflicts:
	src/nrniv/neuronapi.cpp
	src/nrniv/neuronapi.h
	test/api/hh_sim.cpp
	test/api/netcon.cpp
	test/api/sections.c
	test/api/test_common.h
	test/api/vclamp.cpp

sonarcloud bot commented Jan 30, 2024

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

37 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Collaborator

bbpbuildbot commented Jan 30, 2024

azure-pipelines bot commented Jan 30, 2024

✔️ deb29fb -> Azure artifacts URL

ferdonline requested a review from nrnhines

January 31, 2024 10:59

ferdonline marked this pull request as ready for review

January 31, 2024 10:59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment