Add net module, tests, and docs

docs/docs/standard-lib/net.md

@@ -0,0 +1,34 @@
+---
+layout: default
+title: IO
+nav_order: 13
+parent: Standard Library
+---
+
+# IO
+{: .no_toc }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+## Net
+
+To make use of the Net module an import is required.
+
+```cs
+import Net;
+```
+
+### Net.parseIp4(String) -> Result\<List>
+
+parseIp4 takes a string representation of an IP4 address and returns a Result that unwraps to list containing an entry for each octet.
+
+```cs
+Net.parseIp4("10.0.0.2").unwrap();
+// [10, 0, 0, 2]
+```

docs/docs/standard-lib/object.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Object
-nav_order: 13
+nav_order: 14
 parent: Standard Library
 ---
 

docs/docs/standard-lib/path.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Path
-nav_order: 14
+nav_order: 15
 parent: Standard Library
 ---
 

docs/docs/standard-lib/process.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Process
-nav_order: 15
+nav_order: 16
 parent: Standard Library
 ---
 

docs/docs/standard-lib/queue.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Queue
-nav_order: 16
+nav_order: 17
 parent: Standard Library
 ---
 

docs/docs/standard-lib/random.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Random
-nav_order: 17
+nav_order: 18
 parent: Standard Library
 ---
 

docs/docs/standard-lib/socket.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Socket
-nav_order: 18
+nav_order: 19
 parent: Standard Library
 ---
 

docs/docs/standard-lib/sqlite.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Sqlite
-nav_order: 19
+nav_order: 20
 parent: Standard Library
 ---
 

docs/docs/standard-lib/stack.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Stack
-nav_order: 20
+nav_order: 21
 parent: Standard Library
 ---
 

docs/docs/standard-lib/system.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: System
-nav_order: 21
+nav_order: 22
 parent: Standard Library
 ---
 

docs/docs/standard-lib/term.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Term
-nav_order: 22
+nav_order: 23
 parent: Standard Library
 ---
 

docs/docs/standard-lib/unittest.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: UnitTest
-nav_order: 23
+nav_order: 24
 parent: Standard Library
 ---
 

docs/docs/standard-lib/uuid.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: UUID
-nav_order: 24
+nav_order: 25
 parent: Standard Library
 ---
 

examples/ip.du

@@ -0,0 +1,7 @@
+import Net;
+
+
+print(Net.ip4Len);
+print(Net.ip6Len);
+const res = Net.parseIp4("10.1.1.9").unwrap();
+print(res);

src/optionals/net.c

@@ -0,0 +1,84 @@
+#ifdef _WIN32
+#include "windowsapi.h"
+#include <Ws2tcpip.h>
+#else
+#include <arpa/inet.h>
+#endif
+
+#include <string.h>
+
+#include "net.h"
+#include "../vm/vm.h"
+
+#define IP4_LEN 4
+#define IP6_LEN 16
+
+static Value parseIp4(DictuVM *vm, int argCount, Value *args) {
+    if (argCount != 1) {
+        runtimeError(vm, "parseIp4() takes 1 argument (%d given)", argCount);
+        return EMPTY_VAL;
+    }
+
+    if (!IS_STRING(args[0])) {
+        runtimeError(vm, "parseIp4() argument must be a string");
+        return EMPTY_VAL;
+    }
+
+    char *ipStr = AS_CSTRING(args[0]);
+    char ignore[4] = {0};
+
+#ifdef _WIN32
+    if (InetPton(AF_INET, ipStr, ignore) == 0) {
+        return newResultError(vm, "invalid ip4 address");
+    }
+#else
+    if (inet_pton(AF_INET, ipStr, ignore) == 0) {
+        return newResultError(vm, "invalid ip4 address");
+    }
+#endif
+
+    unsigned char value[IP4_LEN] = {0};
+    size_t index = 0;
+
+    while (*ipStr) {
+        if (isdigit((unsigned char)*ipStr)) {
+            value[index] *= 10;
+            value[index] += *ipStr - '0';
+        } else {
+            index++;
+        }
+        ipStr++;
+    }
+
+    ObjList *list = newList(vm);
+    push(vm, OBJ_VAL(list));
+
+    for (int i = 0; i < IP4_LEN; i++) {
+        writeValueArray(vm, &list->values, NUMBER_VAL(value[i]));
+    }
+
+    pop(vm);
+
+    return newResultSuccess(vm, OBJ_VAL(list));
+}
+
+Value createNetModule(DictuVM *vm) {
+    ObjString *name = copyString(vm, "Net", 3);
+    push(vm, OBJ_VAL(name));
+    ObjModule *module = newModule(vm, name);
+    push(vm, OBJ_VAL(module));
+
+    defineNativeProperty(vm, &module->values, "ip4Len", NUMBER_VAL(IP4_LEN));
+    defineNativeProperty(vm, &module->values, "ip6Len", NUMBER_VAL(IP6_LEN));
+
+    /**
+     * Define Net methods
+     */
+    defineNative(vm, &module->values, "parseIp4", parseIp4);
+
+    pop(vm);
+    pop(vm);
+
+    return OBJ_VAL(module);
+}
+

src/optionals/net.h

@@ -0,0 +1,8 @@
+#ifndef dictu_net_h
+#define dictu_net_h
+
+#include "optionals.h"
+
+Value createNetModule(DictuVM *vm);
+
+#endif //dictu_net_h

src/optionals/optionals.c

@@ -11,6 +11,7 @@ BuiltinModules modules[] = {
     {"Path", &createPathModule, false},
     {"Datetime", &createDatetimeModule, false},
     {"Socket", &createSocketModule, false},
+    {"Net", &createNetModule, false},
     {"Random", &createRandomModule, false},
     {"Base64", &createBase64Module, false},
     {"Hashlib", &createHashlibModule, false},

src/optionals/optionals.h

@@ -15,6 +15,7 @@
 #include "c.h"
 #include "datetime.h"
 #include "socket.h"
+#include "net.h"
 #include "random.h"
 #include "base64.h"
 #include "hashlib.h"

tests/net/import.du

@@ -0,0 +1,7 @@
+/**
+* import.du
+*
+* General import file for net module tests.
+*/
+
+import "parseIp4.du";

tests/net/parseIp4.du

@@ -0,0 +1,40 @@
+/**
+ * parseIp.du
+ *
+ * Testing parseIp function and net module constants.
+ *
+ */
+
+from UnitTest import UnitTest;
+
+import Net;
+
+class TestParseIp4 < UnitTest {
+    const ip4Addr = "10.0.0.2";
+
+    testIp4Len() {
+        this.assertEquals(Net.ip4Len, 4);
+    }
+
+    testIp6Len() {
+        this.assertEquals(Net.ip6Len, 16);
+    }
+
+    testParseIp4() {
+        const res = Net.parseIp4(this.ip4Addr);
+        this.assertSuccess(res);
+
+        const parsed = res.unwrap();
+        this.assertEquals(parsed.len(), Net.ip4Len);
+    }
+
+    testParseBadIp4() {
+        const res = Net.parseIp4("900.8");
+        this.assertError(res);
+
+        const res2 = Net.parseIp4("255.256.255.255");
+        this.assertError(res2);
+    }
+}
+
+TestParseIp4().run();

tests/runTests.du

@@ -31,6 +31,7 @@ import "json/import.du";
 import "log/import.du";
 import "path/import.du";
 import "sockets/import.du";
+import "net/import.du";
 import "base64/import.du";
 import "sqlite/import.du";
 import "process/import.du";