Add a Platform class.

- Rename the "process" module to "os". - Add Platform to it. - Static "name" method. - Static "isPosix" method. - Docs and tests!
2016-05-21 12:44:17 -07:00
parent 6bcc64eb61
commit 06731f66d4
20 changed files with 170 additions and 65 deletions
@@ -0,0 +1,7 @@
+^title Module "os"
+
+The os module exposes classes for accessing capabilities provided by the
+underlying operating system.
+
+* [Platform](platform.html)
+* [Process](process.html)
@@ -0,0 +1,26 @@
+^title Platform Class
+
+The Platform class exposes basic information about the operating system Wren is
+running on top of.
+
+## Static Methods
+
+### **name**
+
+The name of the platform. This roughly describes the operating system, and is
+usually one of:
+
+* "iOS"
+* "Linux"
+* "OS X"
+* "POSIX"
+* "Unix"
+* "Windows"
+
+If Wren was compiled for an unknown operating system, returns "Unknown".
+
+### **isPosix**
+
+Returns `true` if the host operating system is known to support the POSIX
+standard. This is true for Linux and other Unices, as well as the various Apple
+operating systems.
@@ -0,0 +1,38 @@
+^title Process Class
+
+The Process class lets you work with operating system processes, including the
+currently running one.
+
+## Static Methods
+
+### **allArguments**
+
+The list of command-line arguments that were passed when the Wren process was
+spawned. This includes the Wren executable itself, the path to the file being
+run (if any), and any other options passed to Wren itself.
+
+If you run:
+
+    :::bash
+    $ wren file.wren arg
+
+This returns:
+
+    :::wren
+    System.print(Process.allArguments) //> ["wren", "file.wren", "arg"]
+
+### **arguments**
+
+The list of command-line arguments that were passed to your program when the
+Wren process was spawned. This does not include arguments handled by Wren
+itself.
+
+If you run:
+
+    :::bash
+    $ wren file.wren arg
+
+This returns:
+
+    :::wren
+    System.print(Process.arguments) //> ["arg"]
@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
+<title>{title} &ndash; Wren</title>
+<link rel="stylesheet" type="text/css" href="../../style.css" />
+<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
+<!-- Tell mobile browsers we're optimized for them and they don't need to crop
+     the viewport. -->
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
+</head>
+<body id="top" class="module">
+<header>
+  <div class="page">
+    <div class="main-column">
+      <h1><a href="../../">wren</a></h1>
+      <h2>a classy little scripting language</h2>
+    </div>
+  </div>
+</header>
+<div class="page">
+  <nav class="big">
+    <ul>
+      <li><a href="../">Modules</a></li>
+      <li><a href="./">os</a></li>
+    </ul>
+    <section>
+      <h2>os classes</h2>
+      <ul>
+        <li><a href="platform.html">Platform</a></li>
+        <li><a href="process.html">Process</a></li>
+      </ul>
+    </section>
+  </nav>
+  <nav class="small">
+    <table>
+      <tr>
+        <td><a href="../">Modules</a></td>
+        <td><a href="./">os</a></td>
+      </tr>
+      <tr>
+        <td colspan="2"><h2>os classes</h2></td>
+      </tr>
+      <tr>
+        <td>
+          <ul>
+            <li><a href="platform.html">Platform</a></li>
+            <li><a href="process.html">Process</a></li>
+          </ul>
+        </td>
+        <td>
+          <ul>
+          </ul>
+        </td>
+      </tr>
+    </table>
+  </nav>
+  <main>
+    <h1>{title}</h1>
+    {html}
+  </main>
+</div>
+<footer>
+  <div class="page">
+    <div class="main-column">
+    <p>Wren lives
+      <a href="https://github.com/munificent/wren">on GitHub</a>
+      &mdash; Made with &#x2764; by
+      <a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
+      <a href="https://github.com/munificent/wren/blob/master/AUTHORS">friends</a>.
+    </p>
+    <div class="main-column">
+  </div>
+</footer>
+</body>
+</html>