agate-lang.github.io/System.html at main · agate-lang/agate-lang.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.12">
<meta name="author" content="v0.1">
<title>System class</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="./rouge-old_github.css">
  <meta name="keywords" content="Agate, programming language, scripting, gamedev" />
  <meta name="description" content="Agate, a simple and embeddable programming language" />
  <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
  <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
  <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
  <link rel="manifest" href="/site.webmanifest">
  <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
  <meta name="msapplication-TileColor" content="#da532c">
  <meta name="theme-color" content="#ffffff">
</head>
<body class="article toc2 toc-right">
<div id="header">
<h1><code>System</code> class</h1>
<div class="details">
<span id="author" class="author">v0.1</span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_static_methods">Static Methods</a>
<ul class="sectlevel2">
<li><a href="#_abort"><strong>abort</strong>(reason)</a></li>
<li><a href="#_args"><strong>args</strong></a></li>
<li><a href="#_clock"><strong>clock</strong></a></li>
<li><a href="#_env"><strong>env</strong>(name)</a></li>
<li><a href="#_gc"><strong>gc</strong>()</a></li>
<li><a href="#_time"><strong>time</strong></a></li>
<li><a href="#_version"><strong>version</strong></a></li>
<li><a href="#_version_string"><strong>version_string</strong></a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><code>System</code> gives access to some system primitives.</p>
</div>
<div class="paragraph">
<p><a href="core.html">&lt; Back to core unit</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_static_methods"><a class="anchor" href="#_static_methods"></a>Static Methods</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_abort"><a class="anchor" href="#_abort"></a><strong>abort</strong>(reason)</h3>
<div class="paragraph">
<p>Abort the current script, terminating with a runtime error. A <code>reason</code> can be displayed.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="mi">0</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="err">
</span><span class="w">  </span><span class="nc">System</span><span class="p">.</span><span class="n">abort</span><span class="p">(</span><span class="s">"Weird!"</span><span class="p">)</span><span class="err">
</span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span><span class="err">
</span><span class="w">  </span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"OK"</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; OK</span><span class="err">
</span><span class="p">}</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_args"><a class="anchor" href="#_args"></a><strong>args</strong></h3>
<div class="paragraph">
<p>Get the arguments on the command line, if supported.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="nc">System</span><span class="p">.</span><span class="n">args</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; []</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_clock"><a class="anchor" href="#_clock"></a><strong>clock</strong></h3>
<div class="paragraph">
<p>Return a <a href="Float.html"><code>Float</code></a> representing the processor time used by the script, in seconds. This measure is approximate, do not rely on it to make real benchmarks.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="k">def</span><span class="w"> </span><span class="n">now</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">System</span><span class="p">.</span><span class="n">clock</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="n">now</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="nc">Float</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; true</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_env"><a class="anchor" href="#_env"></a><strong>env</strong>(name)</h3>
<div class="paragraph">
<p>Return the environment variable named <code>name</code>, or <code>nil</code> if the environment variable does not exist.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="nc">System</span><span class="p">.</span><span class="n">env</span><span class="p">(</span><span class="s">"NOT_A_VALID_NAME"</span><span class="p">))</span><span class="w"> </span><span class="c1">#&gt; nil</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_gc"><a class="anchor" href="#_gc"></a><strong>gc</strong>()</h3>
<div class="paragraph">
<p>Trigger a garbage collection in the virtual machine to free unused memory.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">System</span><span class="p">.</span><span class="n">gc</span><span class="p">()</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_time"><a class="anchor" href="#_time"></a><strong>time</strong></h3>
<div class="paragraph">
<p>Return an <a href="Int.html"><code>Int</code></a> representing the number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="k">def</span><span class="w"> </span><span class="n">now</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">System</span><span class="p">.</span><span class="n">time</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="n">now</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="nc">Int</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; true</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_version"><a class="anchor" href="#_version"></a><strong>version</strong></h3>
<div class="paragraph">
<p>Return the current version of Agate in an <a href="String.html"><code>Array</code></a> form. The first element of the array is the <em>major</em> part of the version, the second element is the <em>minor</em> part of the version and the third element is the <em>patch</em> part of the version.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="nc">System</span><span class="p">.</span><span class="n">version</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; [0, 1, 0]</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_version_string"><a class="anchor" href="#_version_string"></a><strong>version_string</strong></h3>
<div class="paragraph">
<p>Return the current version of Agate in a <a href="String.html"><code>String</code></a> form.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="nc">System</span><span class="p">.</span><span class="n">version_string</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 0.1.0</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="nc">System</span><span class="p">.</span><span class="n">version_string</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="sc">'.'</span><span class="p">))</span><span class="w"> </span><span class="c1">#&gt; [0, 1, 0]</span></code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  messageStyle: "none",
  tex2jax: {
    inlineMath: [["\\(", "\\)"]],
    displayMath: [["\\[", "\\]"]],
    ignoreClass: "nostem|nolatexmath"
  },
  asciimath2jax: {
    delimiters: [["\\$", "\\$"]],
    ignoreClass: "nostem|noasciimath"
  },
  TeX: { equationNumbers: { autoNumber: "none" } }
})
MathJax.Hub.Register.StartupHook("AsciiMath Jax Ready", function () {
  MathJax.InputJax.AsciiMath.postfilterHooks.Add(function (data, node) {
    if ((node = data.script.parentNode) && (node = node.parentNode) && node.classList.contains("stemblock")) {
      data.math.root.display = "block"
    }
    return data
  })
})
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-MML-AM_HTMLorMML"></script>
</body>
</html>