Merge pull request #2 from anderspkd/version-1.0.1

anderspkd · web-flow · commit ba9783390bdc · 2022-05-30T23:25:34.000+02:00
Version 1.0.1
diff --git a/.github/workflows/Checks.yml b/.github/workflows/Checks.yml
@@ -19,6 +19,9 @@ jobs:
     - name: Copyright
       run: ./scripts/check_copyright_headers.py
 
+    - name: Header Guards
+      run: ./scripts/check_header_guards.py
+
     - name: Style
       shell: bash
       run: |
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -16,7 +16,7 @@
 
 cmake_minimum_required( VERSION 3.14 )
 
-project( scl VERSION 1.0.0 DESCRIPTION "Secure Computation Library" )
+project( scl VERSION 1.0.1 DESCRIPTION "Secure Computation Library" )
 
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE Release)
diff --git a/include/scl/math.h b/include/scl/math.h
@@ -26,4 +26,4 @@
 #include "scl/math/vec.h"
 #include "scl/math/z2k.h"
 
-#endif /* _SCL_MATH_H */
+#endif  // _SCL_MATH_H
diff --git a/include/scl/math/fields.h b/include/scl/math/fields.h
@@ -18,6 +18,9 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+#ifndef _SCL_MATH_FIELDS_H
+#define _SCL_MATH_FIELDS_H
+
 #include <cstdint>
 #include <string>
 #include <type_traits>
@@ -98,3 +101,5 @@ struct FieldSelector {
 
 }  // namespace details
 }  // namespace scl
+
+#endif  // _SCL_MATH_FIELDS_H
diff --git a/include/scl/math/la.h b/include/scl/math/la.h
@@ -281,4 +281,4 @@ bool SolveLinearSystem(Vec<T>& x, const Mat<T>& A, const Vec<T>& b) {
 }  // namespace details
 }  // namespace scl
 
-#endif /* _SCL_MATH_LA_H */
+#endif  // _SCL_MATH_LA_H
diff --git a/include/scl/net/channel.h b/include/scl/net/channel.h
@@ -230,4 +230,4 @@ class Channel {
 
 }  // namespace scl
 
-#endif /* _SCL_NET_CHANNEL_H */
+#endif  // _SCL_NET_CHANNEL_H
diff --git a/include/scl/net/config.h b/include/scl/net/config.h
@@ -143,4 +143,4 @@ class NetworkConfig {
 
 }  // namespace scl
 
-#endif /* _SCL_NET_CONFIG_H */
+#endif  // _SCL_NET_CONFIG_H
diff --git a/include/scl/net/discovery/client.h b/include/scl/net/discovery/client.h
@@ -112,4 +112,4 @@ class DiscoveryClient::ReceiveNetworkConfig
 
 }  // namespace scl
 
-#endif /* _SCL_NET_DISCOVERY_CLIENT_H */
+#endif  // _SCL_NET_DISCOVERY_CLIENT_H
diff --git a/include/scl/net/discovery/server.h b/include/scl/net/discovery/server.h
@@ -143,4 +143,4 @@ class DiscoveryServer::SendNetworkConfig
 
 }  // namespace scl
 
-#endif /* _SCL_NET_DISCOVERY_SERVER_H */
+#endif  // _SCL_NET_DISCOVERY_SERVER_H
diff --git a/include/scl/net/mem_channel.h b/include/scl/net/mem_channel.h
@@ -87,4 +87,4 @@ class InMemoryChannel final : public Channel {
 
 }  // namespace scl
 
-#endif /* _SCL_NET_MEM_CHANNEL_H */
+#endif  // _SCL_NET_MEM_CHANNEL_H
diff --git a/include/scl/net/network.h b/include/scl/net/network.h
@@ -115,4 +115,5 @@ class Network {
 };
 
 }  // namespace scl
-#endif /* _SCL_NET_NETWORK_H */
+
+#endif  // _SCL_NET_NETWORK_H
diff --git a/include/scl/net/shared_deque.h b/include/scl/net/shared_deque.h
@@ -139,4 +139,4 @@ std::size_t SharedDeque<T, Allocator>::Size() {
 }  // namespace details
 }  // namespace scl
 
-#endif /* _SCL_NET_SHARED_DEQUE_H */
+#endif  // _SCL_NET_SHARED_DEQUE_H
diff --git a/include/scl/net/tcp_channel.h b/include/scl/net/tcp_channel.h
@@ -62,4 +62,4 @@ class TcpChannel final : public Channel {
 
 }  // namespace scl
 
-#endif /* _SCL_NET_TCP_CHANNEL_H */
+#endif  // _SCL_NET_TCP_CHANNEL_H
diff --git a/include/scl/net/tcp_utils.h b/include/scl/net/tcp_utils.h
@@ -96,4 +96,4 @@ int WriteToSocket(int socket, const unsigned char* src, std::size_t n);
 }  // namespace details
 }  // namespace scl
 
-#endif /* _SCL_NET_TCP_UTILS_H */
+#endif  // _SCL_NET_TCP_UTILS_H
diff --git a/include/scl/net/threaded_sender.h b/include/scl/net/threaded_sender.h
@@ -64,4 +64,4 @@ class ThreadedSenderChannel final : public Channel {
 
 }  // namespace scl
 
-#endif /* _SCL_NET_THREADED_SENDER_H */
+#endif  // _SCL_NET_THREADED_SENDER_H
diff --git a/include/scl/networking.h b/include/scl/networking.h
@@ -28,4 +28,4 @@
 #include "scl/net/network.h"
 #include "scl/net/tcp_channel.h"
 
-#endif /* _SCL_NETWORKING_H */
+#endif  // _SCL_NETWORKING_H
diff --git a/include/scl/p/simple.h b/include/scl/p/simple.h
@@ -18,8 +18,8 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#ifndef _SCL_PROTOCOL_SIMPLE_H
-#define _SCL_PROTOCOL_SIMPLE_H
+#ifndef _SCL_P_SIMPLE_H
+#define _SCL_P_SIMPLE_H
 
 #include <type_traits>
 
@@ -78,4 +78,4 @@ auto Evaluate(S& last, Ctx& context) {
 
 }  // namespace scl
 
-#endif /* _SCL_PROTOCOL_SIMPLE_H */
+#endif  // _SCL_P_SIMPLE_H
diff --git a/include/scl/primitives.h b/include/scl/primitives.h
@@ -24,4 +24,4 @@
 #include "scl/hash.h"
 #include "scl/prg.h"
 
-#endif /* _SCL_PRIMITIVES_H */
+#endif  // _SCL_PRIMITIVES_H
diff --git a/include/scl/scl.h b/include/scl/scl.h
@@ -18,8 +18,8 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#ifndef _SCL_MAIN_H
-#define _SCL_MAIN_H
+#ifndef _SCL_SCL_H
+#define _SCL_SCL_H
 
 #include "scl/math.h"
 #include "scl/networking.h"
@@ -74,4 +74,4 @@ namespace scl {
 namespace details {}
 }  // namespace scl
 
-#endif /* _SCL_MAIN_H */
+#endif  // _SCL_SCL_H
diff --git a/include/scl/secret_sharing.h b/include/scl/secret_sharing.h
@@ -24,4 +24,4 @@
 #include "scl/ss/additive.h"
 #include "scl/ss/shamir.h"
 
-#endif /* _SCL_SECRET_SHARING_H */
+#endif  // _SCL_SECRET_SHARING_H
diff --git a/include/scl/ss/poly.h b/include/scl/ss/poly.h
@@ -254,4 +254,4 @@ std::string Polynomial<T>::ToString(const char* pn, const char* vn) const {
 }  // namespace details
 }  // namespace scl
 
-#endif /* _SCL_SS_POLY_H */
+#endif  // _SCL_SS_POLY_H
diff --git a/scripts/check_header_guards.py b/scripts/check_header_guards.py
@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+
+import os
+
+def check_guards(path, expected_header_guard):
+    with open(path, 'r') as f:
+        opening_header = False
+        lines = f.readlines()
+        i = 0
+        while i < len(lines) - 1:
+            if lines[i].rstrip() == '#ifndef ' + expected_header_guard:
+                if lines[i + 1].rstrip() == '#define ' + expected_header_guard:
+                    opening_header = True
+                break
+            i += 1
+        else:
+            print('No opening header in', path)
+            return False
+
+        good = opening_header \
+            and lines[-1].rstrip() == '#endif  // ' + expected_header_guard
+
+        if not good:
+            print(f'{path} invalid header')
+            print('Expected:')
+            print('#ifndef ' + expected_header_guard)
+            print('#define ' + expected_header_guard)
+            print('#endif  // ' + expected_header_guard)
+            print('Found:')
+            print(lines[i].rstrip())
+            print(lines[i + 1].rstrip())
+            print(lines[-1].rstrip())
+            print('----')
+
+        return good
+
+
+to_truncate = len('include') + 1
+all_good = True
+for path, _, names in os.walk('include'):
+    for n in names:
+        truncated_path = path[to_truncate:]
+        full_name = os.path.join(truncated_path, n)
+        full_name = full_name.replace('/', '_').replace('.', '_')
+        full_name = '_' + full_name
+        full_name = full_name.upper()
+
+        # check that there's an include guard with full_name as the symbol.
+
+        if not check_guards(os.path.join(path, n), full_name):
+            all_good = False
+
+exit(0 if all_good else 1)

Original file line number	Diff line number	Diff line change
`@@ -230,4 +230,4 @@ class Channel {`
`230`	`230`
`231`	`231`	`} // namespace scl`
`232`	`232`
`233`		`-#endif /* _SCL_NET_CHANNEL_H */`
	`233`	`+#endif // _SCL_NET_CHANNEL_H`
Original file line number	Diff line number	Diff line change
`@@ -143,4 +143,4 @@ class NetworkConfig {`
`143`	`143`
`144`	`144`	`} // namespace scl`
`145`	`145`
`146`		`-#endif /* _SCL_NET_CONFIG_H */`
	`146`	`+#endif // _SCL_NET_CONFIG_H`
Original file line number	Diff line number	Diff line change
`@@ -112,4 +112,4 @@ class DiscoveryClient::ReceiveNetworkConfig`
`112`	`112`
`113`	`113`	`} // namespace scl`
`114`	`114`
`115`		`-#endif /* _SCL_NET_DISCOVERY_CLIENT_H */`
	`115`	`+#endif // _SCL_NET_DISCOVERY_CLIENT_H`
Original file line number	Diff line number	Diff line change
`@@ -143,4 +143,4 @@ class DiscoveryServer::SendNetworkConfig`
`143`	`143`
`144`	`144`	`} // namespace scl`
`145`	`145`
`146`		`-#endif /* _SCL_NET_DISCOVERY_SERVER_H */`
	`146`	`+#endif // _SCL_NET_DISCOVERY_SERVER_H`
Original file line number	Diff line number	Diff line change
`@@ -87,4 +87,4 @@ class InMemoryChannel final : public Channel {`
`87`	`87`
`88`	`88`	`} // namespace scl`
`89`	`89`
`90`		`-#endif /* _SCL_NET_MEM_CHANNEL_H */`
	`90`	`+#endif // _SCL_NET_MEM_CHANNEL_H`