Add os package#

2017-06-16 21:41:23 +02:00 · 2017-06-16 21:41:23 +02:00 · ec9b2db4b9
parent f5d0c2af8f
commit ec9b2db4b9
3 changed files with 354 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -28,6 +28,7 @@ string, Hash set.
 * `math`: Arbitrary precision integer and a set of functions.
 * `memory`: Tools for manual memory management (allocators, smart pointers).
 * `network`: URL-Parsing, sockets, utilities.
+* `os`: Platform-independent interfaces to operating system functionality.

 ### Supported compilers

--- a/source/tanya/os/error.d
+++ b/source/tanya/os/error.d
@ -0,0 +1,337 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/**
+ * This module provides a portable way of using operating system error codes.
+ *
+ * Copyright: Eugene Wissner 2017.
+ * License: $(LINK2 https://www.mozilla.org/en-US/MPL/2.0/,
+ *                  Mozilla Public License, v. 2.0).
+ * Authors: $(LINK2 mailto:info@caraus.de, Eugene Wissner)
+ */
+module tanya.os.error;
+
+// Socket API error.
+private template SAError(int posix, int wsa = posix)
+{
+    version (Windows)
+    {
+        enum SAError = 10000 + wsa;
+    }
+    else
+    {
+        alias SAError = posix;
+    }
+}
+
+// Error for Windows and Posix separately.
+private template NativeError(int posix, int win)
+{
+    version (Windows)
+    {
+        alias NativeError = win;
+    }
+    else
+    {
+        alias NativeError = posix;
+    }
+}
+
+version (Windows)
+{
+    private enum eProtocolError = -71;
+}
+else version (OpenBSD)
+{
+    private enum eProtocolError = -71;
+}
+else
+{
+    private enum eProtocolError = 71;
+}
+
+/**
+ * System error code.
+ */
+struct ErrorCode
+{
+    /**
+     * Error code numbers.
+     */
+    enum ErrorNo : int
+    {
+        /// The operation completed successfully.
+        success                   = 0,
+
+        /// Operation not permitted.
+        noPermission              = NativeError!(1, 5),
+
+        /// Interrupted system call.
+        interrupted               = SAError!4,
+
+        /// Bad file descriptor.
+        badDescriptor             = SAError!9,
+
+        /// An operation on a non-blocking socket would block.
+        wouldBlock                = SAError!(11, 35),
+
+        /// Out of memory.
+        noMemory                  = NativeError!(12, 14),
+
+        /// Access denied.
+        accessDenied              = SAError!13,
+
+        /// An invalid pointer address detected.
+        fault                     = SAError!14,
+
+        /// No such device.
+        noSuchDevice              = NativeError!(19, 20),
+
+        /// An invalid argument was supplied.
+        invalidArgument           = SAError!22,
+
+        /// The limit on the number of open file descriptors.
+        tooManyDescriptors        = NativeError!(23, 331),
+
+        /// The limit on the number of open file descriptors.
+        noDescriptors             = SAError!24,
+
+        /// Broken pipe.
+        brokenPipe                = NativeError!(32, 109),
+
+        /// The name was too long.
+        nameTooLong               = SAError!(36, 63),
+
+        /// A socket operation was attempted on a non-socket.
+        notSocket                 = SAError!(88, 38),
+
+        /// Protocol error.
+        protocolError             = eProtocolError,
+
+        /// Message too long.
+        messageTooLong            = SAError!(90, 40),
+
+        /// Wrong protocol type for socket.
+        wrongProtocolType         = SAError!(91, 41),
+
+        /// Protocol not available.
+        noProtocolOption          = SAError!(92, 42),
+
+        /// The protocol is not implemented orR has not been configured.
+        protocolNotSupported      = SAError!(93, 43),
+
+        /// The support for the specified socket type does not exist in this
+        /// address family.
+        socketNotSupported        = SAError!(94, 44),
+
+        /// The address family is no supported by the protocol family.
+        operationNotSupported     = SAError!(95, 45),
+
+        /// Address family specified is not supported.
+        addressFamilyNotSupported = SAError!(97, 47),
+
+        /// Address already in use.
+        addressInUse              = SAError!(98, 48),
+
+        /// The network is not available.
+        networkDown               = SAError!(100, 50),
+
+        /// No route to host.
+        networkUnreachable        = SAError!(101, 51),
+
+        /// Network dropped connection because of reset.
+        networkReset              = SAError!(102, 52),
+
+        /// The connection has been aborted.
+        connectionAborted         = SAError!(103, 53),
+
+        /// Connection reset by peer.
+        connectionReset           = SAError!(104, 54),
+
+        /// No free buffer space is available for a socket operation.
+        noBufferSpace             = SAError!(105, 55),
+
+        /// Transport endpoint is already connected.
+        alreadyConnected          = SAError!(106, 56),
+
+        /// Transport endpoint is not connected.
+        notConnected              = SAError!(107, 57),
+
+        /// Cannot send after transport endpoint shutdown.
+        shutdown                  = SAError!(108, 58),
+
+        /// The connection attempt timed out, or the connected host has failed
+        /// to respond.
+        timedOut                  = SAError!(110, 60),
+
+        /// Connection refused.
+        connectionRefused         = SAError!(111, 61),
+
+        /// Host is down.
+        hostDown                  = SAError!(112, 64),
+
+        /// No route to host.
+        hostUnreachable           = SAError!(113, 65),
+
+        /// Operation already in progress.
+        alreadyStarted            = SAError!(114, 37),
+
+        /// Operation now in progress.
+        inProgress                = SAError!(115, 36),
+
+        /// Operation cancelled.
+        cancelled                 = SAError!(125, 103),
+    }
+
+    /**
+     * Constructor.
+     *
+     * Params:
+     *  value = Numeric error code.
+     */
+    this(const ErrorNo value) pure nothrow @safe @nogc
+    {
+        this.value_ = value;
+    }
+
+    ///
+    pure nothrow @safe @nogc unittest
+    {
+        ErrorCode ec;
+        assert(ec == ErrorCode.success);
+
+        ec = ErrorCode.fault;
+        assert(ec == ErrorCode.fault);
+    }
+
+    /**
+     * Resets this $(D_PSYMBOL ErrorCode) to default
+     * ($(D_PSYMBOL ErrorCode.success)).
+     */
+    void reset() pure nothrow @safe @nogc
+    {
+        this.value_ = ErrorNo.success;
+    }
+
+    ///
+    pure nothrow @safe @nogc unittest
+    {
+        auto ec = ErrorCode(ErrorCode.fault);
+        assert(ec == ErrorCode.fault);
+
+        ec.reset();
+        assert(ec == ErrorCode.success);
+    }
+
+    /**
+     * Returns: Numeric error code.
+     */
+    ErrorNo opCast(T : ErrorNo)() const
+    {
+        return this.value_;
+    }
+
+    /// Ditto.
+    ErrorNo opCast(T : int)() const
+    {
+        return this.value_;
+    }
+
+    ///
+    pure nothrow @safe @nogc unittest
+    {
+        ErrorCode ec = ErrorCode.fault;
+        auto errorNo = cast(ErrorCode.ErrorNo) ec;
+
+        assert(errorNo == ErrorCode.fault);
+        static assert(is(typeof(cast(int) ec)));
+    }
+
+    /**
+     * Assigns another error code or error code number.
+     *
+     * Params:
+     *  that = Numeric error code.
+     *
+     * Returns: $(D_KEYWORD this).
+     */
+    ref ErrorCode opAssign(const ErrorNo that) pure nothrow @safe @nogc
+    {
+        this.value_ = that;
+        return this;
+    }
+
+    /// Ditto.
+    ref ErrorCode opAssign()(auto ref const ErrorCode that)
+    pure nothrow @safe @nogc
+    {
+        this.value_ = that.value_;
+        return this;
+    }
+
+    ///
+    pure nothrow @safe @nogc unittest
+    {
+        {
+            ErrorCode ec;
+            assert(ec == ErrorCode.success);
+
+            ec = ErrorCode.fault;
+            assert(ec == ErrorCode.fault);
+        }
+        {
+            auto ec1 = ErrorCode(ErrorCode.fault);
+            ErrorCode ec2;
+            assert(ec2 == ErrorCode.success);
+
+            ec2 = ec1;
+            assert(ec1 == ec2);
+        }
+    }
+
+    /**
+     * Equality with another error code or error code number.
+     *
+     * Params:
+     *  that = Numeric error code.
+     *
+     * Returns: Whether $(D_KEYWORD this) and $(D_PARAM that) are equal.
+     */
+    bool opEquals(const ErrorNo that) const pure nothrow @safe @nogc
+    {
+        return this.value_ == that;
+    }
+
+    /// Ditto.
+    bool opEquals()(auto ref const ErrorCode that)
+    const pure nothrow @safe @nogc
+    {
+        return this.value_ == that.value_;
+    }
+
+    ///
+    pure nothrow @safe @nogc unittest
+    {
+        {
+            ErrorCode ec1 = ErrorCode.fault;
+            ErrorCode ec2 = ErrorCode.accessDenied;
+
+            assert(ec1 != ec2);
+            assert(ec1 != ErrorCode.accessDenied);
+            assert(ErrorCode.fault != ec2);
+        }
+        {
+            ErrorCode ec1 = ErrorCode.fault;
+            ErrorCode ec2 = ErrorCode.fault;
+
+            assert(ec1 == ec2);
+            assert(ec1 == ErrorCode.fault);
+            assert(ErrorCode.fault == ec2);
+        }
+    }
+
+    private ErrorNo value_ = ErrorNo.success;
+
+    alias ErrorNo this;
+}
--- a/source/tanya/os/package.d
+++ b/source/tanya/os/package.d
@ -0,0 +1,16 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/**
+ * This package provides platform-independent interfaces to operating system
+ * functionality.
+ *
+ * Copyright: Eugene Wissner 2017.
+ * License: $(LINK2 https://www.mozilla.org/en-US/MPL/2.0/,
+ *                  Mozilla Public License, v. 2.0).
+ * Authors: $(LINK2 mailto:info@caraus.de, Eugene Wissner)
+ */
+module tanya.os;
+
+public import tanya.os.error;