reformat with clang-format

.clang-format

@@ -0,0 +1,3 @@
+BasedOnStyle: Mozilla
+IndentWidth: 2
+ColumnLimit: 100

README.md

@@ -47,6 +47,8 @@ where `sync-prefix` is `/ndn/svs` for the example application.
 ## Contributing
 
 Contributions are welcome through GitHub.
+Use `clang-format` to format the code before submitting a pull request.
+The VS Code extension for `clang-format` is recommended to format the code automatically.
 
 ## License
 

examples/chat-pubsub.cpp

@@ -2,16 +2,17 @@
 /*
  * Copyright (c) 2012-2023 University of California, Los Angeles
  *
- * This file is part of ndn-svs, synchronization library for distributed realtime
- * applications for NDN.
+ * This file is part of ndn-svs, synchronization library for distributed
+ * realtime applications for NDN.
  *
- * ndn-svs library is free software: you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free Software
- * Foundation, in version 2.1 of the License.
+ * ndn-svs library is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by the
+ * Free Software Foundation, in version 2.1 of the License.
  *
- * ndn-svs library is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ * ndn-svs library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+ * for more details.
  */
 
 #include <ctime>
@@ -51,22 +52,20 @@ class Program
     opts.maxPubAge = ndn::time::seconds(10);
 
     // Create the Pub/Sub instance
-    m_svsps = std::make_shared<SVSPubSub>(
-      ndn::Name(m_options.prefix),
-      ndn::Name(m_options.m_id),
-      face,
-      std::bind(&Program::onMissingData, this, _1),
-      opts,
-      secOpts);
+    m_svsps = std::make_shared<SVSPubSub>(ndn::Name(m_options.prefix),
+                                          ndn::Name(m_options.m_id),
+                                          face,
+                                          std::bind(&Program::onMissingData, this, _1),
+                                          opts,
+                                          secOpts);
 
     std::cout << "SVS client starting: " << m_options.m_id << std::endl;
 
     // Subscribe to all data packets with prefix /chat (the "topic")
-    m_svsps->subscribe(ndn::Name("/chat"), [] (const auto& subData)
-    {
+    m_svsps->subscribe(ndn::Name("/chat"), [](const auto& subData) {
       std::string content(reinterpret_cast<const char*>(subData.data.data()), subData.data.size());
-      std::cout << subData.producerPrefix << " [" << subData.seqNo << "] : " <<
-                   subData.name << " : ";
+      std::cout << subData.producerPrefix << " [" << subData.seqNo << "] : " << subData.name
+                << " : ";
       if (content.length() > 200) {
         std::cout << "[LONG] " << content.length() << " bytes"
                   << " [" << std::hash<std::string>{}(content) << "]";
@@ -77,8 +76,7 @@ class Program
     });
   }
 
-  void
-  run()
+  void run()
   {
     // Begin processing face events in a separate thread.
     std::thread svsThread([this] { face.processEvents(); });
@@ -101,20 +99,18 @@ class Program
 protected:
   /**
    * Callback on receving a new State Vector from another node.
-   * This will be called regardless of whether the missing data contains any topics
-   * or producers that we are subscribed to.
+   * This will be called regardless of whether the missing data contains any
+   * topics or producers that we are subscribed to.
    */
-  void
-  onMissingData(const std::vector<MissingDataInfo>&)
+  void onMissingData(const std::vector<MissingDataInfo>&)
   {
     // Ignore any other missing data for this example
   }
 
   /**
    * Publish a string message to the group
    */
-  void
-  publishMsg(const std::string& msg)
+  void publishMsg(const std::string& msg)
   {
     // Message to send
     std::string content = msg;
@@ -129,16 +125,18 @@ class Program
       for (auto& c : content)
         c = std::rand() % 26 + 'a';
 
-      std::cout << "> Sending random message with hash [" << std::hash<std::string>{}(content) << "]" << std::endl;
+      std::cout << "> Sending random message with hash [" << std::hash<std::string>{}(content)
+                << "]" << std::endl;
     }
 
     // Note that unlike SVSync, names can be arbitrary,
     // and need not be prefixed with the producer prefix.
-    ndn::Name name("chat");       // topic of publication
-    name.append(m_options.m_id);  // who sent this
-    name.appendTimestamp();       // and when
+    ndn::Name name("chat");      // topic of publication
+    name.append(m_options.m_id); // who sent this
+    name.appendTimestamp();      // and when
 
-    m_svsps->publish(name, ndn::make_span(reinterpret_cast<const uint8_t*>(content.data()), content.size()));
+    m_svsps->publish(
+      name, ndn::make_span(reinterpret_cast<const uint8_t*>(content.data()), content.size()));
   }
 
 private:

examples/chat.cpp

@@ -2,16 +2,17 @@
 /*
  * Copyright (c) 2012-2023 University of California, Los Angeles
  *
- * This file is part of ndn-svs, synchronization library for distributed realtime
- * applications for NDN.
+ * This file is part of ndn-svs, synchronization library for distributed
+ * realtime applications for NDN.
  *
- * ndn-svs library is free software: you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free Software
- * Foundation, in version 2.1 of the License.
+ * ndn-svs library is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by the
+ * Free Software Foundation, in version 2.1 of the License.
  *
- * ndn-svs library is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ * ndn-svs library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+ * for more details.
  */
 
 #include <iostream>
@@ -37,21 +38,23 @@ class Program
     // Use HMAC signing for Sync Interests
     // Note: this is not generally recommended, but is used here for simplicity
     ndn::svs::SecurityOptions securityOptions(m_keyChain);
-    securityOptions.interestSigner->signingInfo.setSigningHmacKey("dGhpcyBpcyBhIHNlY3JldCBtZXNzYWdl");
+    securityOptions.interestSigner->signingInfo.setSigningHmacKey(
+      "dGhpcyBpcyBhIHNlY3JldCBtZXNzYWdl");
 
     // Create the SVSync instance
     m_svs = std::make_shared<ndn::svs::SVSync>(
-      ndn::Name(m_options.prefix),                    // Sync prefix, common for all nodes in the group
-      ndn::Name(m_options.m_id),                      // Unique data prefix for this node
-      face,                                           // Shared NDN face
-      std::bind(&Program::onMissingData, this, _1),   // Callback on learning new sequence numbers from SVS
-      securityOptions);                               // Security configuration
+      ndn::Name(m_options.prefix), // Sync prefix, common for all nodes in the group
+      ndn::Name(m_options.m_id),   // Unique data prefix for this node
+      face,                        // Shared NDN face
+      std::bind(&Program::onMissingData,
+                this,
+                _1),    // Callback on learning new sequence numbers from SVS
+      securityOptions); // Security configuration
 
     std::cout << "SVS client starting: " << m_options.m_id << std::endl;
   }
 
-  void
-  run()
+  void run()
   {
     // Begin processing face events in a separate thread.
     std::thread svsThread([this] { face.processEvents(); });
@@ -75,19 +78,15 @@ class Program
   /**
    * Callback on receving a new State Vector from another node
    */
-  void
-  onMissingData(const std::vector<ndn::svs::MissingDataInfo>& v)
+  void onMissingData(const std::vector<ndn::svs::MissingDataInfo>& v)
   {
     // Iterate over the entire difference set
-    for (size_t i = 0; i < v.size(); i++)
-    {
+    for (size_t i = 0; i < v.size(); i++) {
       // Iterate over each new sequence number that we learned
-      for (ndn::svs::SeqNo s = v[i].low; s <= v[i].high; ++s)
-      {
+      for (ndn::svs::SeqNo s = v[i].low; s <= v[i].high; ++s) {
         // Request a single data packet using the SVSync API
         ndn::svs::NodeID nid = v[i].nodeId;
-        m_svs->fetchData(nid, s, [nid] (const auto& data)
-        {
+        m_svs->fetchData(nid, s, [nid](const auto& data) {
           std::string content(reinterpret_cast<const char*>(data.getContent().value()),
                               data.getContent().value_size());
           std::cout << data.getName() << " : " << content << std::endl;
@@ -99,10 +98,10 @@ class Program
   /**
    * Publish a string message to the SVSync group
    */
-  void
-  publishMsg(std::string_view msg)
+  void publishMsg(std::string_view msg)
   {
-    // Encode the message into a Content TLV block, which is what the SVSync API expects
+    // Encode the message into a Content TLV block, which is what the SVSync API
+    // expects
     auto block = ndn::encoding::makeStringBlock(ndn::tlv::Content, msg);
     m_svs->publishData(block, ndn::time::seconds(1));
   }

ndn-svs/common.hpp

@@ -2,16 +2,17 @@
 /*
  * Copyright (c) 2012-2022 University of California, Los Angeles
  *
- * This file is part of ndn-svs, synchronization library for distributed realtime
- * applications for NDN.
+ * This file is part of ndn-svs, synchronization library for distributed
+ * realtime applications for NDN.
  *
- * ndn-svs library is free software: you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free Software
- * Foundation, in version 2.1 of the License.
+ * ndn-svs library is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by the
+ * Free Software Foundation, in version 2.1 of the License.
  *
- * ndn-svs library is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
- * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ * ndn-svs library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+ * for more details.
  */
 
 #ifndef NDN_SVS_COMMON_HPP
@@ -44,7 +45,7 @@ using SeqNo = uint64_t;
 using ndn::security::ValidationError;
 
 using DataValidatedCallback = std::function<void(const Data&)>;
-using DataValidationErrorCallback = std::function<void(const Data&, const ValidationError&)> ;
+using DataValidationErrorCallback = std::function<void(const Data&, const ValidationError&)>;
 
 } // namespace ndn::svs