Merge pull request #758 from liz3/liz3/doc-fixes

multiple fixes of small things and QOL

CMakeLists.txt

@@ -15,6 +15,7 @@ if (ENABLE_VCPKG)
 endif(ENABLE_VCPKG)
 
 option(BUILD_CLI "Build the CLI" ON)
+option(EXEC_RELOCATE "Relocate the executable to the root dir" ON)
 
 add_subdirectory(src)
 

docs/docs/standard-lib/argparse.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Argparse module an import is required.
 
-```cs
+```js
 from Argparse import Parser;
 ```
 
@@ -36,7 +36,7 @@ const parser = Parser("prog_name", "Program to do all the things");
 const parser = Parser("prog_name", "Program to do all the things", "User defined usage string");
 ```
 
-### Parse.addString(String, String, Bool, string -> Optional)
+### Parser.addString(String, String, Bool, string -> Optional)
 
 To add a new string argument, call the method below with at least the 3 required arguments; name, description, and boolean indicating the flag is required. A fourth argument can be passed to give the parser a custom name for the given flag.
 

docs/docs/standard-lib/bigint.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the BigInt module an import is required.
 
-```cs
+```js
 import BigInt;
 ```
 

docs/docs/standard-lib/datetime.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Datetime module an import is required.
 
-```cs
+```js
 import Datetime;
 ```
 

docs/docs/standard-lib/http.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the HTTP module an import is required. Along with the methods described below, this module also defines constants representing all standard response codes and their associated messages, the standard set of HTTP methods, and common request headers and values.
 
-```cs
+```js
 import HTTP;
 ```
 

docs/docs/standard-lib/io.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the IO module an import is required.
 
-```cs
+```js
 import IO;
 ```
 
@@ -48,6 +48,25 @@ IO.println("Dictu!");
 // Dictu!
 ```
 
+### IO.eprint(...values) -> Nil
+
+Prints a given list of values to stderr.
+
+```cs
+IO.eprint(0);
+// 0
+```
+
+### IO.eprintln(...values) -> Nil
+
+Prints a given list of values to stderr with an appended newline character.
+
+```cs
+IO.eprintln("Dictu!");
+// Dictu!
+```
+
+
 ### IO.copyFile(String: src, String: dst) -> Result\<Nil>
 
 Copies the contents from the source file to the destination file.

docs/docs/standard-lib/json.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the JSON module an import is required.
 
-```cs
+```js
 import JSON;
 ```
 

docs/docs/standard-lib/log.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Log module an import is required.
 
-```cs
+```js
 import Log;
 ```
 

docs/docs/standard-lib/math.md

@@ -21,7 +21,7 @@ parent: Standard Library
 To make use of the Math module an import is required. For the purpose of the documentation, an iterable 
 is either a list, or passing multiple arguments to the function directly.
 
-```cs
+```js
 import Math;
 ```
 

docs/docs/standard-lib/net.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Net module an import is required.
 
-```cs
+```js
 import Net;
 ```
 

docs/docs/standard-lib/object.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Object module an import is required.
 
-```cs
+```js
 import Object;
 ```
 

docs/docs/standard-lib/path.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Path module an import is required.
 
-```cs
+```js
 import Path;
 ```
 
@@ -87,8 +87,6 @@ Path.exists("some/path/to/a/file.du"); // true
 
 Checks whether a given path points to a directory or not. 
 
-**Note:** This is not available on windows systems.
-
 ```cs
 Path.isDir("/usr/bin/"); //true
 ```

docs/docs/standard-lib/process.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Process module an import is required.
 
-```cs
+```js
 import Process;
 ```
 

docs/docs/standard-lib/queue.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Queue module an import is required.
 
-```cs
+```js
 import Queue;
 ```
 

docs/docs/standard-lib/socket.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Socket module an import is required.
 
-```cs
+```js
 import Socket;
 ```
 

docs/docs/standard-lib/stack.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Stack module an import is required.
 
-```cs
+```js
 import Stack;
 ```
 

docs/docs/standard-lib/system.md

@@ -28,8 +28,8 @@ import System;
 | Constant        | Description                                                                                       |
 | --------------- | ------------------------------------------------------------------------------------------------- |
 | System.argv     | The list of command line arguments. The first element of the argv list is always the script name. |
-| System.platform | This string identifies the underlying system platform.                                            |
-| System.arch     | This string identifies the underlying process architecture.                                         |
+| System.platform | This string identifies the underlying system platform(common: `windows`, `linux`, `darwin`).      |
+| System.arch     | This string identifies the underlying process architecture.                                       |
 | System.version  | Dictionary containing Dictu major, minor and patch versions.                                      |
 | System.S_IRWXU  | Read, write, and execute by owner.                                                                |
 | System.S_IRUSR  | Read by owner.                                                                                    |
@@ -212,7 +212,7 @@ System.clock();
 
 ### System.time() -> Number
 
-Returns UNIX timestamp as a number.
+Returns UNIX timestamp in seconds as a number.
 
 ```cs
 System.time();

docs/docs/standard-lib/term.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the Term module an import is required.
 
-```cs
+```js
 import Term;
 ```
 

docs/docs/standard-lib/uuid.md

@@ -20,7 +20,7 @@ parent: Standard Library
 
 To make use of the UUID module an import is required.
 
-```cs
+```js
 import UUID;
 ```
 

ops/checkTests.du

@@ -23,9 +23,6 @@ const ignored = {
         'range.du',
         'select.du',
     ],
-    'ffi': [
-        'libs',
-    ],
     '*': [
         'import.du',
     ]

src/cli/CMakeLists.txt

@@ -1,12 +1,24 @@
 set(DICTU_CLI_SRC main.c linenoise/linenoise.c linenoise/linenoise.h linenoise/stringbuf.c linenoise/stringbuf.h linenoise/utf8.c linenoise/utf8.h)
+if(EXEC_RELOCATE)
 SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR})
-
+endif()
 if(NOT WIN32)
     list(FILTER DICTU_CLI_SRC EXCLUDE REGEX "linenoise-win32.c")
 endif()
 
 add_compile_definitions(USE_UTF8)
 add_executable(dictu ${DICTU_CLI_SRC})
+ execute_process(
+    COMMAND git log -1 --format=%H
+    WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
+    OUTPUT_VARIABLE GIT_HASH
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+add_compile_definitions(GIT_HASH="${GIT_HASH}")
+if(CMAKE_BUILD_TYPE MATCHES Debug)
+    add_compile_definitions(DEBUG DEBUG_STRESS_GC DEBUG_FINAL_MEM)
+endif()
+
 target_include_directories(dictu PUBLIC ${INCLUDE_DIR})
 target_link_libraries(dictu dictu_api_static)
 if(LINUX AND CMAKE_C_COMPILER_ID STREQUAL "Clang")

src/include/dictu_include.h

@@ -7,7 +7,25 @@
 #define DICTU_MINOR_VERSION "30"
 #define DICTU_PATCH_VERSION "0"
 
-#define DICTU_STRING_VERSION "Dictu Version: " DICTU_MAJOR_VERSION "." DICTU_MINOR_VERSION "." DICTU_PATCH_VERSION "\n"
+#ifdef DEBUG
+
+#define DICTU_DEBUG_VERSION_STR "(Debug)"
+
+#else
+
+#define DICTU_DEBUG_VERSION_STR ""
+
+#endif
+
+#if defined(GIT_HASH)
+
+#define DICTU_STRING_VERSION DICTU_DEBUG_VERSION_STR "Dictu Version: "  DICTU_MAJOR_VERSION "." DICTU_MINOR_VERSION "." DICTU_PATCH_VERSION " [rev: " GIT_HASH "]\n"
+
+#else
+
+#define DICTU_STRING_VERSION DICTU_DEBUG_VERSION_STR "Dictu Version: " DICTU_MAJOR_VERSION "." DICTU_MINOR_VERSION "." DICTU_PATCH_VERSION "\n"
+
+#endif
 
 typedef struct _vm DictuVM;
 

src/optionals/ffi/ffi.h → src/optionals/ffi.h

@@ -3,8 +3,8 @@
 
 #include <stdlib.h>
 
-#include "../optionals.h"
-#include "../../vm/vm.h"
+#include "optionals.h"
+#include "../vm/vm.h"
 
 #ifdef _WIN32
 #define LIB_EXTENSION ".dll"

src/optionals/io.c

@@ -38,6 +38,34 @@ static Value printlnIO(DictuVM *vm, int argCount, Value *args) {
     return NIL_VAL;
 }
 
+
+static Value printErrIO(DictuVM *vm, int argCount, Value *args) {
+    if (argCount == 0) {
+        runtimeError(vm, "printErr() takes 1 or more arguments (%d given)", argCount);
+        return EMPTY_VAL;
+    }
+
+    for (int i = 0; i < argCount; ++i) {
+        printValueError(args[i]);
+    }
+
+    return NIL_VAL;
+}
+
+static Value printErrlnIO(DictuVM *vm, int argCount, Value *args) {
+    if (argCount == 0) {
+        runtimeError(vm, "printErrLn() takes 1 or more arguments (%d given)", argCount);
+        return EMPTY_VAL;
+    }
+
+    for (int i = 0; i < argCount; ++i) {
+        printValueError(args[i]);
+        fprintf(stderr, "\n");
+    }
+
+    return NIL_VAL;
+}
+
 #ifdef _WIN32
 static Value copyFileIO(DictuVM *vm, int argCount, Value *args) {
     if (argCount != 2) {
@@ -138,6 +166,8 @@ Value createIOModule(DictuVM *vm) {
      */
     defineNative(vm, &module->values, "print", printIO);
     defineNative(vm, &module->values, "println", printlnIO);
+    defineNative(vm, &module->values, "eprint", printErrIO);
+    defineNative(vm, &module->values, "eprintln", printErrlnIO);
     defineNative(vm, &module->values, "copyFile", copyFileIO);
 
     pop(vm);

src/optionals/optionals.c

@@ -1,5 +1,4 @@
 #include "optionals.h"
-#include "ffi/ffi.h"
 
 BuiltinModules modules[] = {
     {"Argparse", &createArgParseModule, false},

src/optionals/optionals.h

@@ -29,7 +29,7 @@
 #include "object/object.h"
 #include "buffer.h"
 #include "unittest/unittest.h"
-#include "ffi/ffi.h"
+#include "ffi.h"
 
 typedef Value (*BuiltinModule)(DictuVM *vm);