Add bool result from tie()/get(), get<T>(T&,error_code&)

jkeiser · jkeiser · commit 56e2b38048f6 · 2020-06-20T17:55:46.000-07:00
diff --git a/benchmark/statisticalmodel.cpp b/benchmark/statisticalmodel.cpp
@@ -52,7 +52,7 @@ really_inline void simdjson_process_atom(stat_t &s,
   } else if (element.is<bool>()) {
     simdjson::error_code err;
     bool v;
-    element.get<bool>().tie(v,err);
+    element.get(v,err);
     if (v) {
       s.true_count++;
     } else {
diff --git a/doc/basics.md b/doc/basics.md
@@ -84,7 +84,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
   double value; // variable where we store the value to be parsed
   simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2")
   simdjson::dom::parser parser;
-  parser.parse(numberstring).get<double>().tie(value,error);
+  parser.parse(numberstring).get(value,error);
   if (error) { std::cerr << error << std::endl; return EXIT_FAILURE; }
   std::cout << "I parsed " << value << " from " << numberstring.data() << std::endl;
   ```
@@ -213,7 +213,7 @@ dom::parser parser;
 padded_string json = R"(  { "foo": 1, "bar": 2 }  )"_padded;
 dom::object object;
 simdjson::error_code error;
-parser.parse(json).get<dom::object>().tie(object, error);
+parser.parse(json).get(object, error);
 for (dom::key_value_pair field : object) {
   cout << field.key << " = " << field.value << endl;
 }
@@ -299,13 +299,13 @@ auto cars_json = R"( [
 dom::parser parser;
 dom::array cars;
 simdjson::error_code error;
-parser.parse(cars_json).get<dom::array>().tie(cars, error);
+parser.parse(cars_json).get(cars, error);
 if (error) { cerr << error << endl; exit(1); }
 
 // Iterating through an array of objects
 for (dom::element car_element : cars) {
 dom::object car;
-car_element.get<dom::object>().tie(car, error);
+car_element.get(car, error);
 if (error) { cerr << error << endl; exit(1); }
 
 // Accessing a field by name
@@ -318,18 +318,18 @@ cout << "Make/Model: " << make << "/" << model << endl;
 
 // Casting a JSON element to an integer
 uint64_t year;
-car["year"].get<uint64_t>().tie(year, error);
+car["year"].get(year, error);
 if (error) { cerr << error << endl; exit(1); }
 cout << "- This car is " << 2020 - year << "years old." << endl;
 
 // Iterating through an array of floats
 double total_tire_pressure = 0;
 dom::array tire_pressure_array;
-car["tire_pressure"].get<dom::array>().tie(tire_pressure_array, error);
+car["tire_pressure"].get(tire_pressure_array, error);
 if (error) { cerr << error << endl; exit(1); }
 for (dom::element tire_pressure_element : tire_pressure_array) {
     double tire_pressure;
-    tire_pressure_element.get<double>().tie(tire_pressure, error);
+    tire_pressure_element.get(tire_pressure, error);
     if (error) { cerr << error << endl; exit(1); }
     total_tire_pressure += tire_pressure;
 }
@@ -351,31 +351,31 @@ auto abstract_json = R"( [
 dom::parser parser;
 dom::array rootarray;
 simdjson::error_code error;
-parser.parse(abstract_json).get<dom::array>().tie(rootarray, error);
+parser.parse(abstract_json).get(rootarray, error);
 if (error) { cerr << error << endl; exit(1); }
 // Iterate through an array of objects
 for (dom::element elem : rootarray) {
     dom::object obj;
-    elem.get<dom::object>().tie(obj, error);
+    elem.get(obj, error);
     if (error) { cerr << error << endl; exit(1); }
     for(auto & key_value : obj) {
       cout << "key: " << key_value.key << " : ";
       dom::object innerobj;
-      key_value.value.get<dom::object>().tie(innerobj, error);
+      key_value.value.get(innerobj, error);
       if (error) { cerr << error << endl; exit(1); }
 
       double va;
-      innerobj["a"].get<double>().tie(va, error);
+      innerobj["a"].get(va, error);
       if (error) { cerr << error << endl; exit(1); }
       cout << "a: " << va << ", ";
 
       double vb;
-      innerobj["b"].get<double>().tie(vb, error);
+      innerobj["b"].get(vb, error);
       if (error) { cerr << error << endl; exit(1); }
       cout << "b: " << vb << ", ";
 
       int64_t vc;
-      innerobj["c"].get<int64_t>().tie(vc, error);
+      innerobj["c"].get(vc, error);
       if (error) { cerr << error << endl; exit(1); }
       cout << "c: " << vc << endl;
 
@@ -392,7 +392,7 @@ And another one:
   dom::parser parser;
   double v;
   simdjson::error_code error;
-  parser.parse(abstract_json)["str"]["123"]["abc"].get<double>().tie(v, error);
+  parser.parse(abstract_json)["str"]["123"]["abc"].get(v, error);
   if (error) { cerr << error << endl; exit(1); }
   cout << "number: " << v << endl;
 ```
diff --git a/include/simdjson/dom/element.h b/include/simdjson/dom/element.h
@@ -206,6 +206,63 @@ class element {
   template<typename T>
   really_inline simdjson_result<T> get() const noexcept;
 
+  /**
+   * Get the value as the provided type (T).
+   *
+   * Supported types:
+   * - Boolean: bool
+   * - Number: double, uint64_t, int64_t
+   * - String: std::string_view, const char *
+   * - Array: dom::array
+   * - Object: dom::object
+   *
+   * @tparam T bool, double, uint64_t, int64_t, std::string_view, const char *, dom::array, dom::object
+   *
+   * @param value The variable to set to the value. May not be set if there is an error.
+   * @param error The variable to set to the error. Set to SUCCESS if there is no error.
+   *
+   * @returns true if the value was set, or false if there wsa an error.
+   */
+  template<typename T>
+  inline bool get(T &value, error_code &error) const noexcept;
+
+  /**
+   * Get the value as the provided type (T), setting error if it's not the given type.
+   *
+   * Supported types:
+   * - Boolean: bool
+   * - Number: double, uint64_t, int64_t
+   * - String: std::string_view, const char *
+   * - Array: dom::array
+   * - Object: dom::object
+   *
+   * @tparam T bool, double, uint64_t, int64_t, std::string_view, const char *, dom::array, dom::object
+   *
+   * @param value The variable to set to the given type. value is undefined if there is an error.
+   * @param error The variable to store the error. error is set to error_code::SUCCEED if there is an error.
+   */
+  template<typename T>
+  inline void tie(T &value, error_code &error) && noexcept;
+
+  /**
+   * Get the value as the provided type (T).
+   *
+   * Supported types:
+   * - Boolean: bool
+   * - Number: double, uint64_t, int64_t
+   * - String: std::string_view, const char *
+   * - Array: dom::array
+   * - Object: dom::object
+   *
+   * @tparam T bool, double, uint64_t, int64_t, std::string_view, const char *, dom::array, dom::object
+   *
+   * @param value The variable to set to the given type. value is undefined if there is an error.
+   *
+   * @returns true if the value was able to be set, false if there was an error.
+   */
+  template<typename T>
+  WARN_UNUSED inline bool tie(T &value) && noexcept;
+
 #if SIMDJSON_EXCEPTIONS
   /**
    * Read this element as a boolean.
@@ -421,6 +478,8 @@ struct simdjson_result<dom::element> : public internal::simdjson_result_base<dom
   inline simdjson_result<bool> is() const noexcept;
   template<typename T>
   inline simdjson_result<T> get() const noexcept;
+  template<typename T>
+  inline bool get(T &value, error_code &error) const noexcept;
 
   inline simdjson_result<dom::array> get_array() const noexcept;
   inline simdjson_result<dom::object> get_object() const noexcept;
diff --git a/include/simdjson/error.h b/include/simdjson/error.h
@@ -119,8 +119,10 @@ struct simdjson_result_base : public std::pair<T, error_code> {
 
   /**
    * Move the value and the error to the provided variables.
+   *
+   * @return true if the value was set, false if there was an error.
    */
-  really_inline void tie(T &value, error_code &error) && noexcept;
+  really_inline bool tie(T &value, error_code &error) && noexcept;
 
   /**
    * The error.
@@ -181,8 +183,10 @@ struct simdjson_result : public internal::simdjson_result_base<T> {
 
   /**
    * Move the value and the error to the provided variables.
+   *
+   * @return true if the value was set, false if there was an error.
    */
-  really_inline void tie(T& t, error_code & e) && noexcept;
+  really_inline bool tie(T &value, error_code &error) && noexcept;
 
   /**
    * The error.
diff --git a/include/simdjson/inline/element.h b/include/simdjson/inline/element.h
@@ -33,6 +33,15 @@ inline simdjson_result<T> simdjson_result<dom::element>::get() const noexcept {
   if (error()) { return error(); }
   return first.get<T>();
 }
+template<typename T>
+inline bool simdjson_result<dom::element>::get(T &value, error_code &_error) const noexcept {
+  if (error()) {
+    _error = error();
+    return !_error;
+  } else {
+    return first.get(value, _error);
+  }
+}
 
 inline simdjson_result<dom::array> simdjson_result<dom::element>::get_array() const noexcept {
   if (error()) { return error(); }
@@ -267,6 +276,11 @@ inline simdjson_result<object> element::get_object() const noexcept {
   }
 }
 
+template<typename T>
+inline bool element::get(T &value, error_code &error) const noexcept {
+  return get<T>().tie(value, error);
+}
+
 template<typename T>
 inline bool element::is() const noexcept {
   auto result = get<T>();
diff --git a/include/simdjson/inline/error.h b/include/simdjson/inline/error.h
@@ -41,12 +41,13 @@ namespace internal {
 //
 
 template<typename T>
-really_inline void simdjson_result_base<T>::tie(T &value, error_code &error) && noexcept {
+really_inline bool simdjson_result_base<T>::tie(T &value, error_code &error) && noexcept {
   // on the clang compiler that comes with current macOS (Apple clang version 11.0.0),
   // tie(width, error) = size["w"].get<uint64_t>();
   // fails with "error: no viable overloaded '='""
   value = std::forward<simdjson_result_base<T>>(*this).first;
   error = this->second;
+  return !error;
 }
 
 template<typename T>
@@ -95,8 +96,8 @@ really_inline simdjson_result_base<T>::simdjson_result_base() noexcept
 ///
 
 template<typename T>
-really_inline void simdjson_result<T>::tie(T &value, error_code &error) && noexcept {
-  std::forward<internal::simdjson_result_base<T>>(*this).tie(value, error);
+really_inline bool simdjson_result<T>::tie(T &value, error_code &error) && noexcept {
+  return std::forward<internal::simdjson_result_base<T>>(*this).tie(value, error);
 }
 
 template<typename T>
diff --git a/tests/basictests.cpp b/tests/basictests.cpp
@@ -677,7 +677,7 @@ namespace parse_api_tests {
       if (error) { cerr << error << endl; return false; }
 
       dom::array arr;
-      doc.get<dom::array>().tie(arr, error); // let us get the array
+      doc.get(arr, error); // let us get the array
       if (error) { cerr << error << endl; return false; }
 
       if(arr.size() != 9) { cerr << "bad array size"<< endl; return false; }
@@ -1033,11 +1033,11 @@ namespace dom_api_tests {
     if (doc["obj"]["a"].get<uint64_t>().first != 1) { cerr << "Expected uint64_t(doc[\"obj\"][\"a\"]) to be 1, was " << doc["obj"]["a"].first << endl; return false; }
 
     object obj;
-    doc.get<dom::object>().tie(obj, error); //  tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0
+    doc.get(obj, error); //  tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0
     if (error) { cerr << "Error: " << error << endl; return false; }
     if (obj["obj"]["a"].get<uint64_t>().first != 1) { cerr << "Expected uint64_t(doc[\"obj\"][\"a\"]) to be 1, was " << doc["obj"]["a"].first << endl; return false; }
 
-    obj["obj"].get<dom::object>().tie(obj, error); //  tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0
+    obj["obj"].get(obj, error); //  tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0
     if (obj["a"].get<uint64_t>().first != 1) { cerr << "Expected uint64_t(obj[\"a\"]) to be 1, was " << obj["a"].first << endl; return false; }
     if (obj["b"].get<uint64_t>().first != 2) { cerr << "Expected uint64_t(obj[\"b\"]) to be 2, was " << obj["b"].first << endl; return false; }
     if (obj["c/d"].get<uint64_t>().first != 3) { cerr << "Expected uint64_t(obj[\"c\"]) to be 3, was " << obj["c"].first << endl; return false; }
@@ -1071,14 +1071,14 @@ namespace dom_api_tests {
     if (error) { cerr << "Error: " << error << endl; return false; }
     for (auto tweet : tweets) {
       object user;
-      tweet["user"].get<dom::object>().tie(user, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
+      tweet["user"].get(user, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
       if (error) { cerr << "Error: " << error << endl; return false; }
       bool default_profile;
-      user["default_profile"].get<bool>().tie(default_profile, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
+      user["default_profile"].get(default_profile, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
       if (error) { cerr << "Error: " << error << endl; return false; }
       if (default_profile) {
         std::string_view screen_name;
-        user["screen_name"].get<std::string_view>().tie(screen_name, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
+        user["screen_name"].get(screen_name, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
         if (error) { cerr << "Error: " << error << endl; return false; }
         default_users.insert(screen_name);
       }
@@ -1099,13 +1099,13 @@ namespace dom_api_tests {
       if (!not_found) {
         for (auto image : media) {
           object sizes;
-          image["sizes"].get<dom::object>().tie(sizes, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
+          image["sizes"].get(sizes, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
           if (error) { cerr << "Error: " << error << endl; return false; }
           for (auto size : sizes) {
             uint64_t width, height;
-            size.value["w"].get<uint64_t>().tie(width, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
+            size.value["w"].get(width, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
             if (error) { cerr << "Error: " << error << endl; return false; }
-            size.value["h"].get<uint64_t>().tie(height, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
+            size.value["h"].get(height, error); // tie(...) = fails with "no viable overloaded '='" on Apple clang version 11.0.0;
             if (error) { cerr << "Error: " << error << endl; return false; }
             image_sizes.insert(make_pair(width, height));
           }
diff --git a/tests/cast_tester.h b/tests/cast_tester.h
@@ -58,7 +58,7 @@ template<typename T>
 bool cast_tester<T>::test_get(element element, T expected) {
   T actual;
   error_code error;
-  element.get<T>().tie(actual, error);
+  element.get(actual, error);
   ASSERT_SUCCESS(error);
   return assert_equal(actual, expected);
 }
@@ -67,7 +67,7 @@ template<typename T>
 bool cast_tester<T>::test_get(simdjson_result<element> element, T expected) {
   T actual;
   error_code error;
-  element.get<T>().tie(actual, error);
+  element.get(actual, error);
   ASSERT_SUCCESS(error);
   return assert_equal(actual, expected);
 }
@@ -76,7 +76,7 @@ template<typename T>
 bool cast_tester<T>::test_get_error(element element, error_code expected_error) {
   T actual;
   error_code error;
-  element.get<T>().tie(actual, error);
+  element.get(actual, error);
   ASSERT_EQUAL(error, expected_error);
   return true;
 }
@@ -85,7 +85,7 @@ template<typename T>
 bool cast_tester<T>::test_get_error(simdjson_result<element> element, error_code expected_error) {
   T actual;
   error_code error;
-  element.get<T>().tie(actual, error);
+  element.get(actual, error);
   ASSERT_EQUAL(error, expected_error);
   return true;
 }
diff --git a/tests/extracting_values_example.cpp b/tests/extracting_values_example.cpp
@@ -6,7 +6,7 @@ int main() {
   double value; // variable where we store the value to be parsed
   simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2")
   simdjson::dom::parser parser;
-  parser.parse(numberstring).get<double>().tie(value,error);
+  parser.parse(numberstring).get(value,error);
   if (error) { std::cerr << error << std::endl; return EXIT_FAILURE; }
   std::cout << "I parsed " << value << " from " << numberstring.data() << std::endl;
 }
diff --git a/tests/readme_examples.cpp b/tests/readme_examples.cpp
@@ -157,7 +157,7 @@ void basics_cpp17_2() {
   padded_string json = R"(  { "foo": 1, "bar": 2 }  )"_padded;
   dom::object object;
   simdjson::error_code error;
-  parser.parse(json).get<dom::object>().tie(object, error);
+  parser.parse(json).get(object, error);
   for (dom::key_value_pair field : object) {
     cout << field.key << " = " << field.value << endl;
   }
diff --git a/tests/readme_examples_noexceptions.cpp b/tests/readme_examples_noexceptions.cpp
diff --git a/tools/jsonstats.cpp b/tools/jsonstats.cpp

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ int main() {`
`6`	`6`	`double value; // variable where we store the value to be parsed`
`7`	`7`	`simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2")`
`8`	`8`	`simdjson::dom::parser parser;`
`9`		`- parser.parse(numberstring).get<double>().tie(value,error);`
	`9`	`+ parser.parse(numberstring).get(value,error);`
`10`	`10`	`if (error) { std::cerr << error << std::endl; return EXIT_FAILURE; }`
`11`	`11`	`std::cout << "I parsed " << value << " from " << numberstring.data() << std::endl;`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ void basics_cpp17_2() {`
`157`	`157`	`padded_string json = R"( { "foo": 1, "bar": 2 } )"_padded;`
`158`	`158`	`dom::object object;`
`159`	`159`	`simdjson::error_code error;`
`160`		`- parser.parse(json).get<dom::object>().tie(object, error);`
	`160`	`+ parser.parse(json).get(object, error);`
`161`	`161`	`for (dom::key_value_pair field : object) {`
`162`	`162`	`cout << field.key << " = " << field.value << endl;`
`163`	`163`	`}`