Modify upstream's object.pl script to output D code, apply diff

Author: Geod24

scripts/objects.pl

@@ -1,4 +1,23 @@
 #! /usr/bin/env perl
+#
+# Script to generate module `deimos.openssl.object_mac`
+#
+# Upstream uses a script to generate `<openssl/object_mac.h>`.
+# Instead of porting the header, we can simply modify this script
+# to output D code. This script was first copied from openssl-3.0.3 tag,
+# then modified. If it needs updating, check git history for required changes.
+#
+# Since the object definitions are just values, versioning for old versions
+# is not required. Hence one can just update the definitions on a new release
+# using the following commands (assuming CWD is the root of this repository):
+# ````
+# export OSSL_COPYRIGHT_YEAR=2022 # Or later
+# perl -I $PTOR/util/perl/ scripts/objects.pl \
+#   $PTOR/crypto/objects.txt $PTOR/crypto/obj_mac.num \
+#   > source/deimos/openssl/obj_mac.d
+# ```
+# Where $PTOR is the 'path to OpenSSL repository'.
+#
 # Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
 #
 # Licensed under the Apache License 2.0 (the "License").  You may not use
@@ -136,25 +155,25 @@
 }
 
 print <<"EOF";
-/*
+/**
+ * Bindings for `<openssl/obj_mac.h>`
+ *
  * WARNING: do not edit!
- * Generated by crypto/objects/objects.pl
+ * Generated by `scripts/objects.pl`, copied and modified from the upstream
+ * script `crypto/objects/objects.pl`.
  *
  * Copyright 2000-$YEAR The OpenSSL Project Authors. All Rights Reserved.
  * Licensed under the Apache License 2.0 (the "License").  You may not use
  * this file except in compliance with the License.  You can obtain a copy
  * in the file LICENSE in the source distribution or at
  * https://www.openssl.org/source/license.html
  */
+module deimos.openssl.obj_mac;
 
-#ifndef OPENSSL_OBJ_MAC_H
-# define OPENSSL_OBJ_MAC_H
-# pragma once
-
-#define SN_undef                        "UNDEF"
-#define LN_undef                        "undefined"
-#define NID_undef                       0
-#define OBJ_undef                       0L
+enum SN_undef = "UNDEF";
+enum LN_undef = "undefined";
+enum NID_undef = 0;
+enum OBJ_undef = "0L";
 EOF
 
 sub expand
@@ -170,17 +189,12 @@ sub expand
 	{
 	$Cname=$ordern{$_};
 	print "\n";
-	print expand("#define SN_$Cname\t\t\"$sn{$Cname}\"\n") if $sn{$Cname} ne "";
-	print expand("#define LN_$Cname\t\t\"$ln{$Cname}\"\n") if $ln{$Cname} ne "";
-	print expand("#define NID_$Cname\t\t$nid{$Cname}\n") if $nid{$Cname} ne "";
-	print expand("#define OBJ_$Cname\t\t$obj{$Cname}\n") if $obj{$Cname} ne "";
+	print expand("enum SN_$Cname = \"$sn{$Cname}\";\n") if $sn{$Cname} ne "";
+	print expand("enum LN_$Cname = \"$ln{$Cname}\";\n") if $ln{$Cname} ne "";
+	print expand("enum NID_$Cname = $nid{$Cname};\n") if $nid{$Cname} ne "";
+	print expand("enum OBJ_$Cname = \"$obj{$Cname}\";\n") if $obj{$Cname} ne "";
 	}
 
-print <<EOF;
-
-#endif /* OPENSSL_OBJ_MAC_H */
-EOF
-
 sub process_oid
 	{
 	local($oid)=@_;