Skip to content

scope fix, time, docs update #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dishpit merged 13 commits into from
May 30, 2025
Merged

scope fix, time, docs update #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4372b51
time.gem std module first implementation, with C utils functions epoc…
May 26, 2025
bb2de58
added struct Duration to time.gem
May 27, 2025
092f2db
added struct Duration to time.gem
May 27, 2025
ec37c41
identation spaces set to 2 + TIME module renamed to Time
May 30, 2025
6b57ccf
comments add for demonstration/questioning purposes removed
May 30, 2025
b461025
include sleep functions moved outside of function scope
May 30, 2025
9301a80
Merge pull request #11 from DevYatsu/feat/time
Dishpit May 30, 2025
8638c60
newline add at end of file
May 30, 2025
70d39a2
update docs
Dishpit May 30, 2025
f3163d3
Merge pull request #14 from DevYatsu/feat/time-correction
Dishpit May 30, 2025
d83909a
update version
Dishpit May 30, 2025
d86e2de
changeblog
Dishpit May 30, 2025
b41da28
Merge pull request #15 from SimuCorps/docs/time-stl
Dishpit May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 129 additions & 1 deletion docs/changeblog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
<nav class="docs-nav">
<h3>Changeblog</h3>
<ul>
<li><a href="#v1-3-0">Version 1.3.0</a></li>
<li><a href="#v1-2-0">Version 1.2.0</a></li>
<li><a href="#v1-1-0">Version 1.1.0</a></li>
<li><a href="#v1-0-0">Version 1.0.0</a></li>
Expand All @@ -48,6 +49,133 @@ <h1>Gem Changeblog</h1>
<p class="docs-subtitle">The story behind Gem's evolution and design decisions</p>
</header>

<section id="v1-3-0" class="docs-section">
<h2>Version 1.3.0 - Time and Precision</h2>
<p class="version-date"><em>Released: May 30th 2025</em></p>

<h3>Mastering Time and Fixing the Fundamentals</h3>
<p>Version 1.3.0 brings essential time-handling capabilities to Gem while addressing critical scoping issues that were affecting variable resolution. This release focuses on two key areas: providing developers with robust time operations and ensuring the language's core scoping mechanisms work reliably.</p>

<p>The new Time module enables everything from simple delays to sophisticated performance monitoring, while our scoping fixes ensure that variables behave predictably across all contexts. Together, these improvements make Gem more reliable and capable for real-world applications.</p>

<p>We'd like to give a special thanks to <a href="https://github.com/DevYatsu" target="_blank">@DevYatsu</a> for their excellent work on the Time module!</p>

<h3>What Changed</h3>

<h4>Time Module - Comprehensive Time Operations</h4>
<p>The new Time standard library module provides essential time-related functionality for modern applications:</p>

<div class="code-block">
<pre><code>require "time";

# Get current timestamp
puts "Current time: #{Time.now()}";

# Sleep operations with millisecond precision
puts "Starting operation...";
Time.sleep(2000); # Sleep for 2 seconds
puts "Operation completed";

# Function timing for performance monitoring
def heavyWork() void
Time.sleep(1500); # Simulate 1.5 seconds of work
puts "Heavy work completed";
end

# Measure execution time
Time.measure(heavyWork);

# Timeout operations for reliability
def quickTask() void
puts "Quick task executed";
end

def slowTask() void
Time.sleep(5000); # 5 second operation
puts "Slow task completed";
end

# Run with timeout protection
Time.timeout(quickTask, 2); # Should complete
Time.timeout(slowTask, 2); # May timeout</code></pre>
</div>

<h4>Critical Scoping Bug Fixes</h4>
<p>We've resolved several important scoping issues that were causing variable resolution problems:</p>

<div class="code-block">
<pre><code># Variable scoping now works correctly in all contexts
def outerFunction() void
string message = "Hello from outer";

def innerFunction() void
# Can now properly access outer scope variables
puts message; # Works correctly

string localMessage = "Hello from inner";
puts localMessage; # Local scope works too
end

innerFunction();
end

# Class method scoping improvements
class Calculator
def init() void
this.value = 0;
end

def calculate() void
# Method-local variables now scope correctly
int localResult = this.value * 2;
this.value = localResult; # 'this' resolution fixed
end
end</code></pre>
</div>

<h3>Technical Implementation</h3>

<h4>Time Module Architecture</h4>
<p>The Time module is implemented using system-level time functions for accuracy and reliability:</p>
<ul>
<li><strong>High-precision timestamps</strong> - Floating-point timestamps provide microsecond accuracy</li>
<li><strong>Cross-platform sleep</strong> - Millisecond-precision sleep works on all supported platforms</li>
<li><strong>Function timing</strong> - Accurate measurement of function execution duration</li>
<li><strong>Timeout handling</strong> - Attempt to limit function execution time (implementation-dependent)</li>
</ul>

<h4>Scoping System Improvements</h4>
<p>The scoping fixes address fundamental issues in variable resolution:</p>
<ul>
<li><strong>Lexical scoping</strong> - Variables are now correctly resolved based on lexical scope</li>
<li><strong>Closure capture</strong> - Inner functions properly capture outer scope variables</li>
<li><strong>Method resolution</strong> - Class method variable lookup works reliably</li>
<li><strong>Scope chain traversal</strong> - Proper traversal of nested scopes during variable lookup</li>
</ul>

<h3>Design Philosophy</h3>
<p>Version 1.3.0 reflects our commitment to both expanding Gem's capabilities and ensuring rock-solid fundamentals:</p>

<ul>
<li><strong>Essential Functionality</strong> - Time operations are fundamental to modern applications</li>
<li><strong>Reliability First</strong> - Scoping bugs undermine developer confidence and must be fixed</li>
<li><strong>Practical Utility</strong> - Time module enables performance monitoring and timeout handling</li>
<li><strong>Consistent Behavior</strong> - Variable scoping should be predictable and intuitive</li>
</ul>

<h3>Known Limitations</h3>
<p>While the Time module provides essential functionality, there are some current limitations:</p>
<ul>
<li><strong>Duration Class</strong> - Advanced duration arithmetic is not yet available</li>
<li><strong>Time.elapsed()</strong> - Has type compatibility issues and is not recommended</li>
<li><strong>Timeout Reliability</strong> - Timeout interruption may not work in all scenarios</li>
<li><strong>Return Value Handling</strong> - Some functions return values that are difficult to access</li>
</ul>

<h3>Looking Forward</h3>
<p>The Time module foundation opens possibilities for future enhancements like date/time parsing, timezone handling, and more sophisticated timing utilities. It also lays the groundwork for more advanced features like async/await, cryptography, random number generation, and more. The scoping fixes ensure that Gem's core language mechanics are solid as we continue to build more advanced features.</p>
</section>

<section id="v1-2-0" class="docs-section">
<h2>Version 1.2.0 - The Connectivity Update</h2>
<p class="version-date"><em>Released: May 25th 2025</em></p>
Expand Down Expand Up @@ -270,7 +398,7 @@ <h2>What's Next?</h2>
<div class="footer-content">
<div class="footer-brand">
<span class="gem-icon">💎</span>
<span>Gem Programming Language v1.2.2</span>
<span>Gem Programming Language v1.3.0</span>
</div>
<div class="footer-links">
<a href="https://github.com/SimuCorps/Gem" target="_blank">GitHub</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<div class="nav-brand">
<span class="gem-icon">💎</span>
<span class="brand-text">Gem</span>
<span class="version">v1.2.2</span>
<span class="version">v1.3.0</span>
</div>
<ul class="nav-menu">
<li><a href="index.html" class="nav-link active">Home</a></li>
Expand All @@ -33,7 +33,7 @@
<h1 class="hero-title">
<span class="gem-icon-large">💎</span>
Gem Programming Language
<span class="version-badge">v1.2.2</span>
<span class="version-badge">v1.3.0</span>
</h1>
<p class="hero-subtitle">
A modern, statically-typed language that prioritizes safety, clarity, and developer experience.
Expand Down Expand Up @@ -296,7 +296,7 @@ <h3>Functions & Classes</h3>
<div class="footer-content">
<div class="footer-brand">
<span class="gem-icon">💎</span>
<span>Gem Programming Language v1.2.2</span>
<span>Gem Programming Language v1.3.0</span>
</div>
<div class="footer-links">
<a href="https://github.com/SimuCorps/Gem" target="_blank">GitHub</a>
Expand Down
Loading