Re-template json_pointer on string type #3415

falbrechtskirchinger · 2022-04-03T18:27:09Z

This PR changes the json_pointer template parameter from basic_json to string type and deals with unexpected complications.

Most notably, a helper function for string concatenation is introduced to allow for some flexibility in the implementation of string types (and eliminate some temporaries as a positive side-effect). I'll leave it to others to remove more std::string API dependence (some low-hanging fruits are empty(), find_first_of(), substr()).

To Do:

Remove context parameter default value as per greg's suggestion in the previous PR.
Add backwards compatibility with json_pointer<basic_json>.
Update documentation.
Fix issue references in commits once ready for merge. (Don't want to spam GH issues as much.)

coveralls · 2022-04-04T05:05:00Z

Coverage remained the same at 100.0% when pulling fdb15f9 on falbrechtskirchinger:refactor-json_ptr-tpl into 261cc4e on nlohmann:develop.

include/nlohmann/detail/json_pointer.hpp

falbrechtskirchinger · 2022-04-04T11:57:36Z

@nlohmann Can you please take a look at the Codacy report and tell me which tool is generating that strlen warning? This link is not accessible to me: https://app.codacy.com/gh/nlohmann/json/patterns/list?selectedEngine=81806a42-1d70-40e6-ad07-9a1a9da9e500#pattern-6542

include/nlohmann/json.hpp

include/nlohmann/detail/string_concat.hpp

nlohmann · 2022-04-04T17:33:44Z

@nlohmann Can you please take a look at the Codacy report and tell me which tool is generating that strlen warning? This link is not accessible to me: https://app.codacy.com/gh/nlohmann/json/patterns/list?selectedEngine=81806a42-1d70-40e6-ad07-9a1a9da9e500#pattern-6542

Sure:

Looks like a false positive - I ignored the issue. This should become effective in the next check.

falbrechtskirchinger · 2022-04-04T17:39:34Z

@nlohmann Can you please take a look at the Codacy report and tell me which tool is generating that strlen warning? This link is not accessible to me: https://app.codacy.com/gh/nlohmann/json/patterns/list?selectedEngine=81806a42-1d70-40e6-ad07-9a1a9da9e500#pattern-6542

(...)
Looks like a false positive - I ignored the issue. This should become effective in the next check.

Okay, thanks, I would have added // Flawfinder: ignore now that I know the tool.

gregmarr · 2022-04-04T17:43:27Z

Just a thought, instead of const char *cstr, could this be template<int N> ... const char (&cstr)[N] so that we avoid the strlen altogether?

falbrechtskirchinger · 2022-04-04T18:03:20Z

Just a thought, instead of const char *cstr, could this be template<int N> ... const char (&cstr)[N] so that we avoid the strlen altogether?

We'd still need const char * for things like type_name() which returns const char * (*) and then one'd have to handle the ambiguity between the two, either by introducing a helper type with template specialization for both cases or using enable_if/SFINAE.
I considered it but it's not worth the hassle in my opinion.

(*) I mean, we don't have to but it's nice to avoid std::string(type_name()).

falbrechtskirchinger · 2022-04-05T04:47:56Z

Once this passes review, prior to merge, I'd just like to do one last force-push to update commit messages with the issue references.

Edit: Forgot to include json_pointer/string_t.md. Fixed.

gregmarr · 2022-04-05T13:54:36Z

We'd still need const char * for things like type_name()

Agreed that it only makes sense if the only things are string literals and string objects, but doesn't make sense if there are true raw pointers.

test/src/unit-alt-string.cpp

include/nlohmann/detail/json_pointer.hpp

falbrechtskirchinger

I discovered a few minor things in my full review. Will fix momentarily.

include/nlohmann/detail/conversions/from_json.hpp

include/nlohmann/detail/input/binary_reader.hpp

include/nlohmann/detail/string_concat.hpp

include/nlohmann/json.hpp

test/src/unit-alt-string.cpp

test/src/unit-regression2.cpp

falbrechtskirchinger

Ready for final review and merge.

doc/mkdocs/docs/api/json_pointer/index.md

include/nlohmann/detail/meta/type_traits.hpp

include/nlohmann/json.hpp

doc/mkdocs/docs/api/json_pointer/string_t.md

include/nlohmann/detail/json_pointer.hpp

include/nlohmann/json.hpp

Change exception context parameter to pointer and replace context with nullptr where appropriate.

Add variadic concat() function for concatenating char *, char, and string types.

Change json_pointer from being templated on basic_json to being templated on string type.

Closes nlohmann#3388.

falbrechtskirchinger · 2022-04-08T09:32:30Z

@nlohmann 3.10.6 is now 3.11.0, right? So I need to update the version numbers?

nlohmann · 2022-04-08T09:38:45Z

@nlohmann 3.10.6 is now 3.11.0, right? So I need to update the version numbers?

Yes, so much has piled up. But I would have gone throw the release anyway to clean this up.

falbrechtskirchinger · 2022-04-08T09:43:40Z

You probably missed my comment on this closed PR: #3418 (comment)
Interested?

nlohmann · 2022-04-08T09:53:30Z

You probably missed my comment on this closed PR: #3418 (comment)
Interested?

Not right now.

falbrechtskirchinger · 2022-04-08T10:01:33Z

Version numbers updated. Mixed in some accidental edits that were supposed to go into a different branch and fixed that too.

nlohmann

Looks good to me.

nlohmann · 2022-04-12T12:18:20Z

Thanks!

falbrechtskirchinger requested a review from nlohmann as a code owner April 3, 2022 18:27

falbrechtskirchinger marked this pull request as draft April 3, 2022 19:09

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from 0f2ad02 to f42848f Compare April 4, 2022 04:40

falbrechtskirchinger mentioned this pull request Apr 4, 2022

[NFC] Provide exception overloads without context #3375

Closed

nlohmann reviewed Apr 4, 2022

View reviewed changes

include/nlohmann/detail/json_pointer.hpp Outdated Show resolved Hide resolved

gregmarr reviewed Apr 4, 2022

View reviewed changes

include/nlohmann/json.hpp Outdated Show resolved Hide resolved

include/nlohmann/detail/string_concat.hpp Show resolved Hide resolved

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from 537c699 to 081bce9 Compare April 4, 2022 14:33

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from 83b4a65 to 6483203 Compare April 5, 2022 04:41

falbrechtskirchinger marked this pull request as ready for review April 5, 2022 04:42

falbrechtskirchinger commented Apr 5, 2022

View reviewed changes

test/src/unit-alt-string.cpp Show resolved Hide resolved

gregmarr reviewed Apr 5, 2022

View reviewed changes

include/nlohmann/detail/json_pointer.hpp Outdated Show resolved Hide resolved

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from bd2b691 to d930a86 Compare April 5, 2022 17:47

falbrechtskirchinger mentioned this pull request Apr 5, 2022

Implement support for string_view (attempt no. 3) #3423

Merged

gregmarr reviewed Apr 5, 2022

View reviewed changes

include/nlohmann/detail/json_pointer.hpp Outdated Show resolved Hide resolved

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from b5d983f to fc3e0c0 Compare April 6, 2022 06:43

falbrechtskirchinger commented Apr 6, 2022

View reviewed changes

falbrechtskirchinger mentioned this pull request Apr 6, 2022

Conversion from alt_json to json produces incorrect result #3425

Open

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from fc3e0c0 to 8f3b49e Compare April 6, 2022 08:28

falbrechtskirchinger commented Apr 6, 2022

View reviewed changes

nlohmann requested changes Apr 6, 2022

View reviewed changes

gregmarr reviewed Apr 6, 2022

View reviewed changes

Make exception context optional

a3492ae

Change exception context parameter to pointer and replace context with nullptr where appropriate.

falbrechtskirchinger added 3 commits April 7, 2022 06:25

Support escaping other string types

b9d27b6

Add string concatenation function

10e451b

Add variadic concat() function for concatenating char *, char, and string types.

Replace string concatenations using + with concat()

ddd60f2

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from 8f3b49e to 28ef5ee Compare April 7, 2022 04:32

falbrechtskirchinger added 6 commits April 7, 2022 18:24

Template json_pointer on string type

4092fb0

Change json_pointer from being templated on basic_json to being templated on string type.

Add unit test for nlohmann#3388

067c473

Closes nlohmann#3388.

Fix regression test for nlohmann#2958

6f31932

Add backwards compatibility with json_pointer<basic_json>

38f251f

Update json_pointer docs

03dbf3e

Allow comparing different json_pointers

f5f975a

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from bebf36a to f5f975a Compare April 7, 2022 16:25

falbrechtskirchinger requested a review from nlohmann April 8, 2022 09:29

Update version numbers

fdb15f9

falbrechtskirchinger force-pushed the refactor-json_ptr-tpl branch from 2dcfd0c to fdb15f9 Compare April 8, 2022 09:57

nlohmann approved these changes Apr 12, 2022

View reviewed changes

nlohmann self-assigned this Apr 12, 2022

nlohmann added this to the Release 3.11.0 milestone Apr 12, 2022

nlohmann added the release item: 🔨 further change label Apr 12, 2022

nlohmann merged commit 616caea into nlohmann:develop Apr 12, 2022

falbrechtskirchinger deleted the refactor-json_ptr-tpl branch April 12, 2022 13:45

falbrechtskirchinger mentioned this pull request Nov 14, 2022

array_index does not catch std::invalid_argument exception from std::stoull #3831

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-template json_pointer on string type #3415

Re-template json_pointer on string type #3415

falbrechtskirchinger commented Apr 3, 2022 •

edited

Loading

coveralls commented Apr 4, 2022 •

edited

Loading

falbrechtskirchinger commented Apr 4, 2022

nlohmann commented Apr 4, 2022

falbrechtskirchinger commented Apr 4, 2022

gregmarr commented Apr 4, 2022

falbrechtskirchinger commented Apr 4, 2022

falbrechtskirchinger commented Apr 5, 2022 •

edited

Loading

gregmarr commented Apr 5, 2022

falbrechtskirchinger left a comment

falbrechtskirchinger left a comment

falbrechtskirchinger commented Apr 8, 2022

nlohmann commented Apr 8, 2022

falbrechtskirchinger commented Apr 8, 2022

nlohmann commented Apr 8, 2022

falbrechtskirchinger commented Apr 8, 2022

nlohmann left a comment

nlohmann commented Apr 12, 2022

Re-template json_pointer on string type #3415

Re-template json_pointer on string type #3415

Conversation

falbrechtskirchinger commented Apr 3, 2022 • edited Loading

coveralls commented Apr 4, 2022 • edited Loading

falbrechtskirchinger commented Apr 4, 2022

nlohmann commented Apr 4, 2022

falbrechtskirchinger commented Apr 4, 2022

gregmarr commented Apr 4, 2022

falbrechtskirchinger commented Apr 4, 2022

falbrechtskirchinger commented Apr 5, 2022 • edited Loading

gregmarr commented Apr 5, 2022

falbrechtskirchinger left a comment

Choose a reason for hiding this comment

falbrechtskirchinger left a comment

Choose a reason for hiding this comment

falbrechtskirchinger commented Apr 8, 2022

nlohmann commented Apr 8, 2022

falbrechtskirchinger commented Apr 8, 2022

nlohmann commented Apr 8, 2022

falbrechtskirchinger commented Apr 8, 2022

nlohmann left a comment

Choose a reason for hiding this comment

nlohmann commented Apr 12, 2022

falbrechtskirchinger commented Apr 3, 2022 •

edited

Loading

coveralls commented Apr 4, 2022 •

edited

Loading

falbrechtskirchinger commented Apr 5, 2022 •

edited

Loading