DAW JSON Link
Loading...
Searching...
No Matches
daw_json_value.h
Go to the documentation of this file.
1// Copyright (c) Darrell Wright
2//
3// Distributed under the Boost Software License, Version 1.0. (See accompanying
4// file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
5//
6// Official repository: https://github.com/beached/daw_json_link
7//
8
9#pragma once
10
12
24
25#include <daw/daw_algorithm.h>
26#include <daw/daw_attributes.h>
27#include <daw/daw_move.h>
28#include <daw/daw_utility.h>
29
30#include <cassert>
31#include <cstddef>
32#include <daw/stdinc/tuple_traits.h>
33#include <optional>
34#include <string_view>
35
36namespace daw::json {
37 inline namespace DAW_JSON_VER {
40 template<json_options_t PolicyFlags = json_details::default_policy_flag,
41 typename Allocator = json_details::NoAllocator>
49
50 template<std::size_t Idx, json_options_t PolicyFlags, typename Allocator>
51 constexpr decltype( auto )
53 static_assert(
54 Idx < 2,
55 "Invalid index. Valid values are 0 for name, and 1 for value" );
56 if constexpr( Idx == 0 ) {
57 return parse_state.name;
58 } else {
59 return parse_state.value;
60 }
61 }
62
63 template<std::size_t Idx, json_options_t PolicyFlags, typename Allocator>
64 constexpr decltype( auto )
66 static_assert(
67 Idx < 2,
68 "Invalid index. Valid values are 0 for name, and 1 for value" );
69 if constexpr( Idx == 0 ) {
70 return parse_state.name;
71 } else {
72 return parse_state.value;
73 }
74 }
75
76 template<std::size_t Idx, json_options_t PolicyFlags, typename Allocator>
77 constexpr decltype( auto )
79 static_assert(
80 Idx < 2,
81 "Invalid index. Valid values are 0 for name, and 1 for value" );
82 if constexpr( Idx == 0 ) {
83 return std::move( parse_state.name );
84 } else {
85 return std::move( parse_state.value );
86 }
87 }
88 } // namespace DAW_JSON_VER
89} // namespace daw::json
90
91namespace std {
92 template<daw::json::json_options_t PolicyFlags, typename Allocator>
93 class tuple_element<0, daw::json::basic_json_pair<PolicyFlags, Allocator>> {
94 public:
95 using type = std::optional<std::string_view>;
96 };
97
98 template<daw::json::json_options_t PolicyFlags, typename Allocator>
99 class tuple_element<1, daw::json::basic_json_pair<PolicyFlags, Allocator>> {
100 public:
102 };
103
104 template<daw::json::json_options_t PolicyFlags, typename Allocator>
105 class tuple_size<daw::json::basic_json_pair<PolicyFlags, Allocator>> {
106 public:
107 static constexpr std::size_t value = 2;
108 };
109} // namespace std
110
111namespace daw::json {
112 inline namespace DAW_JSON_VER {
116 template<json_options_t PolicyFlags = json_details::default_policy_flag,
117 typename Allocator = json_details::NoAllocator>
119 using key_type = std::string_view;
121
125 using pointer = json_details::arrow_proxy<value_type>;
126 using difference_type = std::ptrdiff_t;
127 using iterator_category = std::forward_iterator_tag;
130
131 private:
133 ParseState m_state{ };
134
135 public:
136 explicit basic_json_value_iterator( ) = default;
137
138 explicit constexpr basic_json_value_iterator(
139 parse_policy const &parse_state )
140 : m_state( parse_state ) {}
141
142 explicit basic_json_value_iterator( daw::string_view json_doc )
143 : m_state( std::data( json_doc ), daw::data_end( json_doc ) ) {}
144
145 explicit basic_json_value_iterator( daw::string_view json_doc,
146 Allocator const &alloc )
147 : m_state( std::data( json_doc ), daw::data_end( json_doc ),
148 std::data( json_doc ), daw::data_end( json_doc ), alloc ) {}
149
152 : m_state( jv.get_raw_state( ) ) {}
153
156 [[nodiscard]] constexpr std::optional<std::string_view> name( ) const {
157 if( is_array( ) ) {
158 return { };
159 }
160 auto parse_state = m_state;
161 auto result = json_details::parse_name( parse_state );
162 return std::string_view( std::data( result ), std::size( result ) );
163 }
164
168 [[nodiscard]] constexpr basic_json_value<PolicyFlags, Allocator>
169 value( ) const {
170 if( is_array( ) ) {
171 return ParseState( m_state );
172 }
173 auto parse_state = m_state;
174 (void)json_details::parse_name( parse_state );
175 return ParseState( parse_state.first,
176 parse_state.last,
177 parse_state.first,
178 parse_state.last,
179 parse_state.get_allocator( ) );
180 }
181
184 [[nodiscard]] constexpr basic_json_pair<PolicyFlags, Allocator>
186 if( is_array( ) ) {
187 return { { },
188 basic_json_value( ParseState( m_state.first,
189 m_state.last,
190 m_state.first,
191 m_state.last,
192 m_state.get_allocator( ) ) ) };
193 }
194 auto parse_state = m_state;
195 auto name = json_details::parse_name( parse_state );
196 return {
197 std::string_view( std::data( name ), std::size( name ) ),
198 basic_json_value( ParseState( parse_state.first,
199 parse_state.last,
200 parse_state.first,
201 parse_state.last,
202 parse_state.get_allocator( ) ) ) };
203 }
204
209 [[nodiscard]] constexpr pointer operator->( ) {
210 return { operator*( ) };
211 }
212
216 if( good( ) ) {
217 if( is_class( ) ) {
218 (void)json_details::parse_name( m_state );
219 }
220 (void)json_details::skip_value( m_state );
221 m_state.move_next_member_or_end( );
222 }
223 return *this;
224 }
225
227 constexpr void operator++( int ) & {
228 operator++( );
229 }
230
233 [[nodiscard]] constexpr bool is_array( ) const {
234 return *m_state.class_first == '[';
235 }
236
239 [[nodiscard]] constexpr bool is_class( ) const {
240 return *m_state.class_first == '{';
241 }
242
245 [[nodiscard]] constexpr bool good( ) const {
246 if( m_state.is_null( ) or not m_state.has_more( ) ) {
247 return false;
248 }
249 switch( m_state.front( ) ) {
250 case '[':
251 case '{':
252 case '"':
253 case '-':
254 case '0':
255 case '1':
256 case '2':
257 case '3':
258 case '4':
259 case '5':
260 case '6':
261 case '7':
262 case '8':
263 case '9':
264 case 't':
265 case 'f':
266 case 'n':
267 return true;
268 case '}':
269 case ']':
270 return false;
271 default:
272 DAW_UNLIKELY_BRANCH
273 daw_json_error( true, ErrorReason::ExpectedTokenNotFound, m_state );
274 }
275 }
276
279 [[nodiscard]] constexpr explicit operator bool( ) const {
280 return good( );
281 }
282
285 [[nodiscard]] constexpr parse_policy const &get_raw_state( ) const {
286 return m_state;
287 }
288
292 template<json_options_t P, typename A>
293 [[nodiscard]] constexpr bool
295 if( good( ) ) {
296 if( rhs.good( ) ) {
297 return m_state.first == rhs.m_state.first;
298 }
299 return false;
300 }
301 return not rhs.good( );
302 }
303
307 template<json_options_t P, typename A>
308 [[nodiscard]] constexpr bool
310 return not operator==( rhs );
311 }
312 };
313
314 template<json_options_t PolicyFlags, typename Allocator>
318
319 basic_json_value_iterator( daw::string_view )
321
322 template<typename Allocator>
323 basic_json_value_iterator( daw::string_view, Allocator const & )
324 -> basic_json_value_iterator<daw::json::json_details::default_policy_flag,
325 Allocator>;
326
327 template<json_options_t PolicyFlags, typename Allocator>
331
334 template<json_options_t PolicyFlags = json_details::default_policy_flag,
335 typename Allocator = json_details::NoAllocator>
340
341 [[nodiscard]] constexpr iterator begin( ) {
342 return first;
343 }
344 [[nodiscard]] constexpr iterator end( ) {
345 return last;
346 }
347 };
348
349 template<json_options_t PolicyFlags, typename Allocator>
354
358 template<json_options_t PolicyFlags, typename Allocator>
362 ParseState m_parse_state{ };
365 using size_type = std::size_t;
366 using difference_type = std::ptrdiff_t;
367
368 basic_json_value( ) = default;
369
372 template<json_options_t P, typename A>
373 explicit constexpr basic_json_value( BasicParsePolicy<P, A> parse_state )
374 : m_parse_state( std::move( parse_state ) ) {
375 // Ensure we are at the actual value.
376 m_parse_state.trim_left( );
377 }
378
380 explicit constexpr basic_json_value( daw::string_view sv )
381 : m_parse_state( std::data( sv ), daw::data_end( sv ) ) {
382 m_parse_state.trim_left( );
383 }
384
386 explicit constexpr basic_json_value( char const *first DAW_LIFETIME_BOUND,
387 std::size_t sz )
388 : m_parse_state( first, first + static_cast<std::ptrdiff_t>( sz ) ) {
389 m_parse_state.trim_left( );
390 }
391
393 explicit constexpr basic_json_value( char const *first DAW_LIFETIME_BOUND,
394 char const *last )
395 : m_parse_state( first, last ) {
396 m_parse_state.trim_left( );
397 }
398
401 [[nodiscard]] constexpr ParseState get_raw_state( ) const {
402 return m_parse_state;
403 }
404
405 [[nodiscard]] constexpr std::string_view get_raw_json_document( ) const {
406 return std::string_view( m_parse_state.first, m_parse_state.size( ) );
407 }
408
412 [[nodiscard]] constexpr iterator begin( ) const {
413 auto parse_state = ParseState( m_parse_state.first,
414 m_parse_state.last,
415 m_parse_state.first,
416 m_parse_state.last,
417 m_parse_state.get_allocator( ) );
418 parse_state.remove_prefix( );
419 parse_state.trim_left( );
420 return iterator( parse_state );
421 }
422
425 [[nodiscard]] constexpr iterator end( ) const {
426 return iterator( );
427 }
428
433 [[nodiscard]] constexpr basic_json_value
434 find_class_member( daw::string_view name ) const {
435 if( type( ) != JsonBaseParseTypes::Class ) {
436 return basic_json_value{ };
437 }
438 bool const has_escape = name.contains( '\\' );
439 auto pos = [&] {
440 if( has_escape ) {
441 return daw::algorithm::find_if(
442 begin( ), end( ), [name]( auto const &jp ) {
443 assert( jp.name );
444 auto f0 = std::data( name );
445 auto const l0 = daw::data_end( name );
446 auto f1 = std::data( *jp.name );
447 auto const l1 = daw::data_end( *jp.name );
448 while( f0 != l0 and f1 != l1 ) {
449 if( *f0 == '\\' ) {
450 ++f0;
451 continue;
452 }
453 if( *f0 != *f1 ) {
454 return false;
455 }
456 ++f0;
457 ++f1;
458 }
459 return f0 == l0 and f1 == l1;
460 } );
461 } else {
462 return daw::algorithm::find_if(
463 begin( ), end( ), [name]( auto const &jp ) {
464 assert( jp.name );
465 return jp.name == name;
466 } );
467 }
468 }( );
469
470 if( pos == end( ) ) {
471 return basic_json_value( );
472 }
473 return ( *pos ).value;
474 }
475
478 [[nodiscard]] constexpr basic_json_value
479 find_member( daw::string_view json_path ) const {
480 auto jv = *this;
481 while( not json_path.empty( ) and jv ) {
482 auto member = [&] {
483 if( json_path.front( ) == '[' ) {
484 return json_path.pop_front_until( ']' );
485 }
486 return json_path.pop_front_until( escaped_any_of<'.', '['>{ },
487 nodiscard );
488 }( );
489 if( not json_path.empty( ) and json_path.front( ) == '.' ) {
490 json_path.remove_prefix( );
491 }
492 if( member.front( ) == '[' ) {
493 member.remove_prefix( );
494 auto index_ps =
496 std::data( member ), daw::data_end( member ) )
497 .with_allocator( m_parse_state.get_allocator( ) );
498 auto const index =
499 json_details::unsigned_parser<std::size_t,
500 options::JsonRangeCheck::Never,
501 true>( index_ps );
502
503 jv = jv.find_element( index );
504 if( not json_path.empty( ) and json_path.front( ) == '.' ) {
505 json_path.remove_prefix( );
506 }
507 continue;
508 }
509 jv = jv.find_class_member( member );
510 }
511 return jv;
512 }
513
516 template<typename Result>
517 [[nodiscard]] constexpr auto as( ) const {
518 using result_t = json_details::json_deduced_type<Result>;
519 auto state = m_parse_state;
520 return json_details::
521 parse_value<result_t, false, result_t::expected_type>( state );
522 }
523
524 template<typename Result>
525 [[nodiscard]] explicit operator Result( ) const {
526 return as<Result>( );
527 }
528
533 [[nodiscard]] constexpr basic_json_value
534 operator[]( daw::string_view json_path ) const {
535 return find_member( json_path );
536 }
537
541 [[nodiscard]] constexpr basic_json_value
542 find_element( std::size_t index ) const {
543 auto first = begin( );
544 auto const last = end( );
545 while( nsc_and( index > 0, first != last ) ) {
546 --index;
547 ++first;
548 }
549 if( index == 0 ) {
550 return ( *first ).value;
551 }
552 return basic_json_value( );
553 }
554
557 [[nodiscard]] constexpr basic_json_value
558 find_array_element( std::size_t index ) const {
559 assert( type( ) == JsonBaseParseTypes::Array );
560 return find_element( index );
561 }
562
566 [[nodiscard]] constexpr basic_json_value
567 operator[]( std::size_t index ) const {
568 return find_element( index );
569 }
570
574 [[nodiscard]] constexpr JsonBaseParseTypes type( ) const {
575 if( m_parse_state.empty( ) ) {
576 return JsonBaseParseTypes::None;
577 }
578 switch( m_parse_state.front( ) ) {
579 case '"':
580 return JsonBaseParseTypes::String;
581 case '{':
582 return JsonBaseParseTypes::Class;
583 case '[':
584 return JsonBaseParseTypes::Array;
585 case '-':
586 case '0':
587 case '1':
588 case '2':
589 case '3':
590 case '4':
591 case '5':
592 case '6':
593 case '7':
594 case '8':
595 case '9':
596 return JsonBaseParseTypes::Number;
597 case 't':
598 if constexpr( not ParseState::is_unchecked_input ) {
599 if( m_parse_state.starts_with( "true" ) ) {
600 return JsonBaseParseTypes::Bool;
601 }
602 return JsonBaseParseTypes::None;
603 } else {
604 return JsonBaseParseTypes::Bool;
605 }
606 case 'f':
607 if constexpr( not ParseState::is_unchecked_input ) {
608 if( m_parse_state.starts_with( "false" ) ) {
609 return JsonBaseParseTypes::Bool;
610 }
611 return JsonBaseParseTypes::None;
612 } else {
613 return JsonBaseParseTypes::Bool;
614 }
615 case 'n':
616 daw_json_assert_weak( m_parse_state.starts_with( "null" ),
617 ErrorReason::InvalidNull,
618 m_parse_state );
619 return JsonBaseParseTypes::Null;
620 }
621 return JsonBaseParseTypes::None;
622 }
623
626 [[nodiscard]] constexpr ParseState get_state( ) const {
627 auto parse_state = m_parse_state;
628 auto result = json_details::skip_value( parse_state );
629 if( is_string( ) ) {
630 --result.first;
631 ++result.last;
632 }
633 return result;
634 }
635
639 [[nodiscard]] constexpr std::string_view get_string_view( ) const {
640 auto parse_state = m_parse_state;
641 auto result = json_details::skip_value( parse_state );
642 return { std::data( result ), std::size( result ) };
643 }
644
648 template<typename Alloc = std::allocator<char>,
649 typename Traits = std::char_traits<char>>
650 [[nodiscard]] std::basic_string<char, Traits, Alloc>
651 get_string( Alloc const &alloc = Alloc( ) ) const {
652 auto parse_state = m_parse_state;
653 auto result = json_details::skip_value( parse_state );
654 return { std::data( result ), std::size( result ), alloc };
655 }
656
659 [[nodiscard]] constexpr bool is_null( ) const {
660 return type( ) == JsonBaseParseTypes::Null;
661 }
662
665 [[nodiscard]] constexpr bool is_class( ) const {
666 return type( ) == JsonBaseParseTypes::Class;
667 }
668
671 [[nodiscard]] constexpr bool is_array( ) const {
672 return type( ) == JsonBaseParseTypes::Array;
673 }
674
677 [[nodiscard]] constexpr bool is_number( ) const {
678 return type( ) == JsonBaseParseTypes::Number;
679 }
680
683 [[nodiscard]] constexpr bool is_string( ) const {
684 return type( ) == JsonBaseParseTypes::String;
685 }
686
689 [[nodiscard]] constexpr bool is_bool( ) const {
690 return type( ) == JsonBaseParseTypes::Bool;
691 }
692
697 [[nodiscard]] constexpr bool is_unknown( ) const {
698 return type( ) == JsonBaseParseTypes::None;
699 }
700
702 template<json_options_t P, typename A>
703 [[nodiscard]] constexpr
704 operator basic_json_value<P, A>( ) const noexcept {
705 auto new_range =
706 BasicParsePolicy<P, A>( m_parse_state.first, m_parse_state.last );
707 new_range.class_first = m_parse_state.class_first;
708 new_range.class_last = m_parse_state.class_last;
709 return basic_json_value<P, A>( std::move( new_range ) );
710 }
711
713 [[nodiscard]] explicit constexpr operator bool( ) const {
714 return type( ) != JsonBaseParseTypes::None;
715 }
716 };
717
718 template<json_options_t PolicyFlags, typename Allocator>
721
722 basic_json_value( daw::string_view ) -> basic_json_value<>;
723
724 basic_json_value( char const *first, std::size_t sz ) -> basic_json_value<>;
725
726 basic_json_value( char const *first, char const *last )
728
729 template<typename Result, json_options_t PolicyFlags, typename Allocator>
730 [[nodiscard]] constexpr Result
732 return jv.template as<Result>( );
733 }
734
735 namespace json_details {
736 // Will be specialized
737 template<typename>
738 inline constexpr bool is_json_value = false;
739
740 template<json_options_t PolicyFlags, typename Allocator>
741 inline constexpr bool
742 is_json_value<basic_json_value<PolicyFlags, Allocator>> = true;
743
744 template<json_options_t PolicyFlags, typename Allocator>
745 inline constexpr bool
746 is_string_view_like_v<basic_json_value<PolicyFlags, Allocator>> = false;
747 } // namespace json_details
748 } // namespace DAW_JSON_VER
749} // namespace daw::json
#define daw_json_assert_weak(Bool,...)
Assert that Bool is true when in Checked Input mode If false pass rest of args to daw_json_error.
DAW_ATTRIB_NOINLINE void daw_json_error(bool b, ErrorReason reason)
daw::conditional_t< ParsePolicy::is_default_parse_policy, DefaultParsePolicy, ParsePolicy > TryDefaultParsePolicy
constexpr Result as(basic_json_value< PolicyFlags, Allocator > const &jv)
constexpr decltype(auto) get(basic_json_pair< PolicyFlags, Allocator > const &parse_state)
Customization point traits.
Handles the bounds and policy items for parsing execution and comments.
TryDefaultParsePolicy< BasicParsePolicy< PolicyFlags, Allocator > > ParseState
a rudimentary range object for holding basic_json_value_iterator
Iterator for iterating over arbitrary JSON members and array elements.
constexpr pointer operator->()
Return an arrow_proxy object containing the result of operator* Should not use this method unless you...
constexpr std::optional< std::string_view > name() const
Name of member.
constexpr parse_policy const & get_raw_state() const
Get access to the internal state. Should not be used as part of public API.
TryDefaultParsePolicy< BasicParsePolicy< PolicyFlags, Allocator > > parse_policy
constexpr basic_json_value< PolicyFlags, Allocator > value() const
Get the value currently being referenced.
constexpr basic_json_value_iterator & operator++()
Move the parser to the next value.
constexpr bool is_class() const
Is the value this iterator iterates over an class.
constexpr bool is_array() const
Is the value this iterator iterates over an array.
constexpr bool operator==(basic_json_value_iterator< P, A > const &rhs) const
Check for equivalence with rhs iterator.
basic_json_value_iterator(daw::string_view json_doc, Allocator const &alloc)
basic_json_value_iterator(basic_json_value< PolicyFlags, Allocator > const &jv)
constexpr basic_json_pair< PolicyFlags, Allocator > operator*()
Get the name/value pair of the currently referenced element.
constexpr bool operator!=(basic_json_value_iterator< P, A > const &rhs) const
Check if rhs is not equivalent to self.
A non-owning container for arbitrary JSON values that allows movement/iteration through.
constexpr bool is_null() const
Is the JSON value a null literal.
constexpr bool is_class() const
Is the JSON value a class.
constexpr std::string_view get_string_view() const
Construct a string range of the current value. Strings start inside the quotes.
constexpr bool is_bool() const
Is the JSON value a boolean.
constexpr iterator end() const
End of range over class/arrays members/items.
constexpr basic_json_value operator[](daw::string_view json_path) const
Query the current class for a named member.
TryDefaultParsePolicy< BasicParsePolicy< PolicyFlags, Allocator > > ParseState
constexpr ParseState get_state() const
Construct a string range of the current value.
constexpr basic_json_value(daw::string_view sv)
Construct from string_view.
constexpr basic_json_value(char const *first DAW_LIFETIME_BOUND, std::size_t sz)
Construct from char const *, std::size_t.
constexpr auto as() const
Parse the current json member as a Result. The Result type must be supported or mapped via a json_dat...
constexpr basic_json_value find_array_element(std::size_t index) const
Find the nth element of the current json array.
constexpr iterator begin() const
Get the first member/item.
constexpr basic_json_value find_element(std::size_t index) const
Find the nth element/submember of the current json array or class.
constexpr basic_json_value find_member(daw::string_view json_path) const
find a class member/array element as specified by the json_path
constexpr bool is_array() const
Is the JSON value a array.
constexpr bool is_string() const
Is the JSON value a string.
constexpr bool is_number() const
Is the JSON value a number literal.
constexpr ParseState get_raw_state() const
Get a copy of the underlying parse state.
std::basic_string< char, Traits, Alloc > get_string(Alloc const &alloc=Alloc()) const
Construct a string range of the current value. Strings start inside the quotes.
constexpr basic_json_value(BasicParsePolicy< P, A > parse_state)
Construct from IteratorRange.
constexpr bool is_unknown() const
Is the JSON data unrecognizable. JSON members will start with one of ",[,{,0,1,2,3,...
constexpr basic_json_value(char const *first DAW_LIFETIME_BOUND, char const *last)
Construct from char const *, char const *.
constexpr JsonBaseParseTypes type() const
Get the type of JSON value.
constexpr basic_json_value operator[](std::size_t index) const
Find the nth element/submember of the current json array or class.
constexpr basic_json_value find_class_member(daw::string_view name) const
Query the current class for a named member.
#define DAW_JSON_VER
The version string used in namespace definitions. Must be a valid namespace name.
Definition version.h:20