fixing up todo comments; other code cleanup

danpape · danpape · commit 683aefe278cf · 2024-02-22T07:22:54.000-08:00
diff --git a/jsonld-cpp/CMakeLists.txt b/jsonld-cpp/CMakeLists.txt
@@ -107,9 +107,7 @@ set_target_properties(jsonld-cpp PROPERTIES CXX_EXTENSIONS OFF)
 
 # Set version
 
-target_compile_definitions(jsonld-cpp PRIVATE -DJSONLDCPP_VERSION_MAJOR=${JSONLDCPP_VERSION_MAJOR})
-target_compile_definitions(jsonld-cpp PRIVATE -DJSONLDCPP_VERSION_MINOR=${JSONLDCPP_VERSION_MINOR})
-target_compile_definitions(jsonld-cpp PRIVATE -DJSONLDCPP_VERSION_PATCH=${JSONLDCPP_VERSION_PATCH})
+target_compile_definitions(jsonld-cpp PRIVATE -DJSONLDCPP_VERSION=${JSONLDCPP_VERSION})
 
 if(JSONLDCPP_BUILD_TESTS)
   enable_testing()
diff --git a/jsonld-cpp/Context.h b/jsonld-cpp/Context.h
@@ -61,13 +61,13 @@ class Context {
 
     std::string getDefaultBaseDirection() const; // used by expansion processor
 
-    const JsonLdOptions &getOptions() const;// used by expansion processor
+    const JsonLdOptions &getOptions() const;// used by context and expansion processor
 
     void setDefaultBaseDirection(const std::string & direction); // used by context processor
 
-    const nlohmann::ordered_json &getTermDefinitions() const;
+    const nlohmann::ordered_json &getTermDefinitions() const; // used by context processor
 
-    nlohmann::ordered_json &getTermDefinitions() ;
+    nlohmann::ordered_json &getTermDefinitions(); // used by context processor
 };
 
 #endif //LIBJSONLD_CPP_CONTEXT_H
diff --git a/jsonld-cpp/ContextProcessor.h b/jsonld-cpp/ContextProcessor.h
@@ -1,5 +1,5 @@
-#ifndef JSONLD_CPP_LIBRARY_CONTEXTPROCESSOR_H
-#define JSONLD_CPP_LIBRARY_CONTEXTPROCESSOR_H
+#ifndef LIBJSONLD_CPP_CONTEXTPROCESSOR_H
+#define LIBJSONLD_CPP_CONTEXTPROCESSOR_H
 
 #include "jsonld-cpp/Context.h"
 #include "jsonld-cpp/jsoninc.h"
@@ -38,4 +38,4 @@ struct ContextProcessor {
 };
 
 
-#endif //JSONLD_CPP_LIBRARY_CONTEXTPROCESSOR_H
+#endif //LIBJSONLD_CPP_CONTEXTPROCESSOR_H
diff --git a/jsonld-cpp/ExpansionProcessor.cpp b/jsonld-cpp/ExpansionProcessor.cpp
@@ -281,13 +281,15 @@ namespace {
         return activeContext;
     }
 
-    void expandObjectElement_step13(const std::string *activeProperty, const json &element, const std::string &baseUrl,
-             Context &typeScopedContext, const std::string &inputType, Context &activeContext, json &result,
-                                    json &nests);
+    void expandObjectElement_step13(
+            const std::string *activeProperty, const json &element, const std::string &baseUrl,
+            Context &typeScopedContext, const std::string &inputType, Context &activeContext, json &result,
+            json &nests);
 
-    void expandObjectElement_step14(Context &activeContext, const std::string *activeProperty, const json &element,
-                                    const std::string &baseUrl, Context &typeScopedContext, json &result,
-                                    json &nests, const std::string &inputType);
+    void expandObjectElement_step14(
+            Context &activeContext, const json &element,
+            const std::string &baseUrl, Context &typeScopedContext, json &result,
+            json &nests, const std::string &inputType);
 
     json expandObjectElement(
             Context activeContext,
@@ -366,7 +368,7 @@ namespace {
 
         // 14)
         // For each key nesting-key in nests, ordered lexicographically if ordered is true:
-        expandObjectElement_step14(activeContext, activeProperty, element, baseUrl, typeScopedContext, result,
+        expandObjectElement_step14(activeContext, element, baseUrl, typeScopedContext, result,
                                    nests, inputType);
 
         // 15)
@@ -1009,7 +1011,7 @@ namespace {
                 for (json::iterator it = element_value.begin(); it != element_value.end(); ++it) {
                     value_keys.push_back(it.key());
                 }
-                // todo: if I comment the next line then I fix 7 tests, but that doesn't seem right
+
                 if(activeContext.getOptions().isOrdered())
                     std::sort(value_keys.begin(), value_keys.end());
 
@@ -1349,7 +1351,7 @@ namespace {
         }
     }
 
-    void expandObjectElement_step14(Context &activeContext, const std::string *activeProperty, const json &element,
+    void expandObjectElement_step14(Context &activeContext, const json &element,
                                     const std::string &baseUrl, Context &typeScopedContext, json &result,
                                     json &nests, const std::string &inputType) {
         // 14)
@@ -1421,7 +1423,7 @@ namespace {
 
                 // 14)
                 // For each key nesting-key in nests, ordered lexicographically if ordered is true:
-                expandObjectElement_step14(copyActiveContext, &nestingKey, nestedValue, baseUrl, typeScopedContext, result,
+                expandObjectElement_step14(copyActiveContext, nestedValue, baseUrl, typeScopedContext, result,
                                            localNests, inputType);
 
             }
@@ -1450,7 +1452,7 @@ json ExpansionProcessor::expand(
     // 2)
     // If active property is @default, initialize the frameExpansion flag to false.
     if (activeProperty != nullptr && *activeProperty == JsonLdConsts::DEFAULT) {
-        //todo: activeContext.getOptions().setFrameExpansion(false);
+        // todo: activeContext.getOptions().setFrameExpansion(false);
     }
 
     // 3)
diff --git a/jsonld-cpp/ExpansionProcessor.h b/jsonld-cpp/ExpansionProcessor.h
@@ -1,5 +1,5 @@
-#ifndef JSONLD_CPP_LIBRARY_EXPANSIONPROCESSOR_H
-#define JSONLD_CPP_LIBRARY_EXPANSIONPROCESSOR_H
+#ifndef LIBJSONLD_CPP_EXPANSIONPROCESSOR_H
+#define LIBJSONLD_CPP_EXPANSIONPROCESSOR_H
 
 #include "jsonld-cpp/jsoninc.h"
 
@@ -34,4 +34,4 @@ struct ExpansionProcessor {
 };
 
 
-#endif //JSONLD_CPP_LIBRARY_EXPANSIONPROCESSOR_H
+#endif //LIBJSONLD_CPP_EXPANSIONPROCESSOR_H
diff --git a/jsonld-cpp/JsonLdOptions.cpp b/jsonld-cpp/JsonLdOptions.cpp
@@ -1,32 +1,27 @@
 #include "jsonld-cpp/JsonLdOptions.h"
 
-
-// definitions needed here for static members (though not necessary in c++17)
-//constexpr const char JsonLdOptions::JSON_LD_1_0[];
-//constexpr const char JsonLdOptions::JSON_LD_1_1[];
-//constexpr bool JsonLdOptions::DEFAULT_COMPACT_ARRAYS;
-
-bool JsonLdOptions::isFrameExpansion() const {
-    return frameExpansion_;
-}
-
-void JsonLdOptions::setFrameExpansion(bool frameExpansion) {
-    frameExpansion_ = frameExpansion;
-}
-
-bool JsonLdOptions::isOrdered() const {
-    return ordered_;
-}
-
-void JsonLdOptions::setOrdered(bool ordered) {
-    ordered_ = ordered;
-}
-
-const std::string &JsonLdOptions::getHashAlgorithm() const {
-    return hashAlgorithm_;
-}
-
-void JsonLdOptions::setHashAlgorithm(const std::string &hashAlgorithm) {
-    hashAlgorithm_ = hashAlgorithm;
-}
+//
+//bool JsonLdOptions::isFrameExpansion() const {
+//    return frameExpansion_;
+//}
+//
+//void JsonLdOptions::setFrameExpansion(bool frameExpansion) {
+//    frameExpansion_ = frameExpansion;
+//}
+//
+//bool JsonLdOptions::isOrdered() const {
+//    return ordered_;
+//}
+//
+//void JsonLdOptions::setOrdered(bool ordered) {
+//    ordered_ = ordered;
+//}
+//
+//const std::string &JsonLdOptions::getHashAlgorithm() const {
+//    return hashAlgorithm_;
+//}
+//
+//void JsonLdOptions::setHashAlgorithm(const std::string &hashAlgorithm) {
+//    hashAlgorithm_ = hashAlgorithm;
+//}
 //todo: why are these functions defined here? can they just all be in the header file?
diff --git a/jsonld-cpp/JsonLdOptions.h b/jsonld-cpp/JsonLdOptions.h
@@ -159,13 +159,21 @@ class JsonLdOptions {
         return *this;
     }
 
-    bool isFrameExpansion() const;
+    bool isFrameExpansion() const {
+        return frameExpansion_;
+    }
 
-    void setFrameExpansion(bool frameExpansion);
+    void setFrameExpansion(bool frameExpansion) {
+        frameExpansion_ = frameExpansion;
+    }
 
-    bool isOrdered() const;
+    bool isOrdered() const {
+        return ordered_;
+    }
 
-    void setOrdered(bool ordered);
+    void setOrdered(bool ordered) {
+        ordered_ = ordered;
+    }
 
     bool getCompactArrays() const {
         return compactArrays_;
@@ -197,9 +205,6 @@ class JsonLdOptions {
 
     void setProcessingMode(const std::string& processingMode) {
         this->processingMode_ = processingMode;
-//        if (processingMode == JsonLdConsts::JSON_LD_1_1) {
-//            omitGraph_ = true;
-//        }
     }
 
     std::string getBase() const {
@@ -250,9 +255,13 @@ class JsonLdOptions {
         this->documentLoader_ = std::move(documentLoader);
     }
 
-    const std::string &getHashAlgorithm() const;
+    const std::string &getHashAlgorithm() const {
+        return hashAlgorithm_;
+    }
 
-    void setHashAlgorithm(const std::string &hashAlgorithm);
+    void setHashAlgorithm(const std::string &hashAlgorithm) {
+        hashAlgorithm_ = hashAlgorithm;
+    }
 
 };
 
diff --git a/jsonld-cpp/JsonLdProcessor.cpp b/jsonld-cpp/JsonLdProcessor.cpp
@@ -127,8 +127,7 @@ RDFDataset JsonLdProcessor::toRDF(const std::string& documentLocation, JsonLdOpt
 
     // 1)
     // Create a new Promise promise and return it. The following steps are then deferred.
-    // Note: we do not feel Promises are appropriate in this spec
-    // todo: word more nicely and make sure you denote personal notes from spec notes
+    // Note: the current implementation of jsonld-cpp does not use Promises.
 
     // 2)
     // Set expanded input to the result of using the expand() method using input and options
diff --git a/jsonld-cpp/RDFSerializationProcessor.cpp b/jsonld-cpp/RDFSerializationProcessor.cpp
@@ -161,9 +161,6 @@ namespace {
             if (!graph.contains(id)) {
                 json tmp = { { JsonLdConsts::ID, id } };
                 graph[id] = tmp;
-                // knowing the insertion order comes in handy later in RDFDataset::graphToRDF()
-                // todo: does it still come in handy?
-                graph["key_insertion_order"].push_back(id);
             }
             // 6.4)
             // Reference the value of the id entry of graph using the variable node.
@@ -653,9 +650,7 @@ namespace {
         // For each subject and node in graph ordered by subject:
         std::vector<std::string> subjects;
         for (auto& el : graph.items()) {
-            // skip the key_insertion_order helper we added in generateNodeMap()
-            if(el.key() != "key_insertion_order") // todo: do i still need to bother with the key insertion order?
-                subjects.push_back(el.key());
+            subjects.push_back(el.key());
         }
         std::sort(subjects.begin(), subjects.end());
 
diff --git a/jsonld-cpp/RDFSerializationProcessor.h b/jsonld-cpp/RDFSerializationProcessor.h
@@ -1,5 +1,5 @@
-#ifndef JSONLD_CPP_LIBRARY_RDFSERIALIZATIONPROCESSOR_H
-#define JSONLD_CPP_LIBRARY_RDFSERIALIZATIONPROCESSOR_H
+#ifndef LIBJSONLD_CPP_RDFSERIALIZATIONPROCESSOR_H
+#define LIBJSONLD_CPP_RDFSERIALIZATIONPROCESSOR_H
 
 #include "jsonld-cpp/jsoninc.h"
 
@@ -28,4 +28,4 @@ struct RDFSerializationProcessor {
 };
 
 
-#endif //JSONLD_CPP_LIBRARY_RDFSERIALIZATIONPROCESSOR_H
+#endif //LIBJSONLD_CPP_RDFSERIALIZATIONPROCESSOR_H
diff --git a/jsonld-cpp/WellFormed.cpp b/jsonld-cpp/WellFormed.cpp
@@ -1,7 +1,6 @@
 #include <regex>
 #include "WellFormed.h"
 #include "JsonLdUtils.h"
-#include "BlankNodeNames.h"
 #include "RDFRegex.h"
 
 bool WellFormed::iri(const std::string &str) {
@@ -14,13 +13,6 @@ bool WellFormed::blankNodeIdentifier(const std::string &str) {
     return std::regex_match(str, match, re);
 }
 
-/**
- * Check if str is a well-formed language.
- *
- *
- * @param str
- * @return
- */
 bool WellFormed::language(const std::string &str) {
     // The JSON-LD spec mentions in several places that a "language is
     // well-formed according to section 2.2.9 of [BCP47]" and BCP47 contains
@@ -33,7 +25,6 @@ bool WellFormed::language(const std::string &str) {
     return std::regex_match(str, match, re);
 }
 
-
 bool WellFormed::literal(const std::string &str) {
     std::regex re(RDFRegex::LITERAL);
     std::smatch match;
@@ -56,4 +47,3 @@ bool WellFormed::rdf_graph_name(const std::string &str) {
     return iri(str) || blankNodeIdentifier(str);
 }
 
-
diff --git a/jsonld-cpp/WellFormed.h b/jsonld-cpp/WellFormed.h
@@ -1,5 +1,5 @@
-#ifndef JSONLD_CPP_LIBRARY_WELLFORMED_H
-#define JSONLD_CPP_LIBRARY_WELLFORMED_H
+#ifndef LIBJSONLD_CPP_WELLFORMED_H
+#define LIBJSONLD_CPP_WELLFORMED_H
 
 
 #include <string>
@@ -101,4 +101,4 @@ class WellFormed {
 };
 
 
-#endif //JSONLD_CPP_LIBRARY_WELLFORMED_H
+#endif //LIBJSONLD_CPP_WELLFORMED_H
diff --git a/jsonld-cpp/jsoninc.h b/jsonld-cpp/jsoninc.h
@@ -12,6 +12,7 @@
 #pragma GCC diagnostic ignored "-Wall"
 #pragma GCC diagnostic ignored "-Wextra"
 #define JSON_USE_IMPLICIT_CONVERSIONS 0
+#define JSON_USE_GLOBAL_UDLS 0
 #include "jsonld-cpp/json.hpp"
 #pragma clang diagnostic pop
 #pragma GCC diagnostic pop
diff --git a/jsonld-cpp/test/testjsonld-cpp/test_ObjectComparisons.cpp b/jsonld-cpp/test/testjsonld-cpp/test_ObjectComparisons.cpp
@@ -107,8 +107,7 @@ namespace {
     };
 
     // sort order should be: A < C < B ... similar to literals < blanknode < IRI
-    struct BasePtrLess :
-            public std::binary_function<const std::shared_ptr<Base>, const std::shared_ptr<Base>, bool> {
+    struct BasePtrLess {
         bool operator()(const std::shared_ptr<Base> & ps1, const std::shared_ptr<Base> & ps2) const {
             if(ps1->isB()) {
                 if(!ps2->isB())
@@ -128,22 +127,19 @@ namespace {
         }
     };
 
-    struct APtrLess :
-            public std::binary_function<const std::shared_ptr<A>, const std::shared_ptr<A>, bool> {
+    struct APtrLess {
         bool operator()(const std::shared_ptr<A> & ps1, const std::shared_ptr<A> & ps2) const {
             return ps1->getValue() < ps2->getValue();
         }
     };
 
-    struct BPtrLess :
-            public std::binary_function<const std::shared_ptr<B>, const std::shared_ptr<B>, bool> {
+    struct BPtrLess {
         bool operator()(const std::shared_ptr<B> & ps1, const std::shared_ptr<B> & ps2) const {
             return ps1->getValue() < ps2->getValue();
         }
     };
 
-    struct CPtrLess :
-            public std::binary_function<const std::shared_ptr<C>, const std::shared_ptr<C>, bool> {
+    struct CPtrLess {
         bool operator()(const std::shared_ptr<C> & ps1, const std::shared_ptr<C> & ps2) const {
             return ps1->getValue() < ps2->getValue();
         }
