Bump version.

Author: sisshiki1969

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "ruruby"
-version = "0.3.1"
+version = "0.4.1"
 authors = ["monochrome <[email protected]>"]
 edition = "2018"
 license-file = "LICENSE"
@@ -28,7 +28,7 @@ divrem = "1.0.0"
 fxhash = "0.2.1"
 chrono = "0.4.15"
 terminal_size = "0.1.16"
-console = "0.14.0"
+console = "0.15.0"
 dirs = "4.0.0"
 smallvec = "1.5.0"
 arraystring = "0.3.0"

Cargo.toml

@@ -1,37 +1,6 @@
 use super::*;
 use std::ops::IndexMut;
 
-//
-//  Stack handling
-//
-//  before frame preparation
-//
-//   lfp                            cfp                                                                 sp
-//    v                              v                                  <------ new local frame ----->   v
-// +------+------+--+------+------+------+------+------+------+--------+------+------+--+------+------+------------------------
-// |  a0  |  a1  |..|  an  | self | flg1 | cfp2 | mfp1 |  pc2 |  ....  |  b0  |  b1  |..|  bn  | self |
-// +------+------+--+------+------+------+------+------+------+--------+------+------+--+------+------+------------------------
-//  <------- local frame --------> <-- control frame ->
-//
-//
-//  after frame preparation
-//
-//   lfp1                           cfp1                                 lfp                            cfp                            sp
-//    v                              v                                    v                              v                              v
-// +------+------+--+------+------+------+------+------+------+--------+------+------+--+------+------+------+------+------+------+---
-// |  a0  |  a1  |..|  an  | self | flg1 | cfp2 | mfp1 |  pc2 |  ....  |  b0  |  b1  |..|  bn  | self | flg  | cfp1 | mfp  |  pc1 |
-// +------+------+--+------+------+------+------+------+------+--------+------+------+--+------+------+------+------+------+------+---
-//                                                                      <------- local frame --------> <------- control frame -------
-//
-//  after execution
-//
-//   lfp                            cfp                                   sp
-//    v                              v                                     v
-// +------+------+--+------+------+------+------+------+------+--------+-------------------------------------------------------
-// |  a0  |  a1  |..|  an  | self | flg1 | cfp2 | mfp1 |  pc2 |  ....  |
-// +------+------+--+------+------+------+------+------+------+--------+-------------------------------------------------------
-//
-
 pub const CFP_OFFSET: usize = 0;
 pub const LFP_OFFSET: usize = 1;
 pub const FLAG_OFFSET: usize = 2;
@@ -44,7 +13,7 @@ pub const BLK_OFFSET: usize = 8;
 pub const NATIVE_FRAME_LEN: usize = 3;
 pub const RUBY_FRAME_LEN: usize = 9;
 
-/// Control frame.
+/// Control frame on the RubyStack.
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub struct Frame(pub usize);
 
@@ -241,6 +210,13 @@ impl ControlFrame {
     }
 }
 
+///
+/// Dynamic frame
+///
+/// Wrapped raw pointer which points to a control frame on the stack or heap.
+/// You can obtain or alter various information like cfp, lfp, and the number of local variables
+/// in the frame through `DynamicFrame`.
+///
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub struct DynamicFrame(*mut Value);
 
@@ -300,6 +276,12 @@ impl DynamicFrame {
     }
 }
 
+///
+/// Local frame
+///
+/// Wrapped raw pointer which points to a local variables area on the stack or heap.
+/// You can handle local variables of the frame.
+///
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub struct LocalFrame(pub(super) *mut Value);
 

src/vm/executor/frame.rs

@@ -1,20 +1,40 @@
 # structure of stack frame
 
+This document describes a structure of stack frames.
+
+## Ruby method/block
+
          lfp                                             cfp                                                            sp
           v                                               v                                                              v
      --+------+------+--+------+------+--+------+------+------+------+------+------+------+------+------+------+------+-----
-       |  a0  |  a1  |..|  an  |  l0  |..|  ln  | self | flag |precfp| mfp  | dfp  |  pc  | ctx  | iseq | lfp  | blok |
+       |  a0  |  a1  |..|  an  |  l0  |..|  ln  | self |precfp| lfp  | flg  | mfp  | dfp  |  pc  | heap | iseq | blok |
      --+------+------+--+------+------+--+------+------+------+------+------+------+------+------+------+------+------+-----
         <------------ local frame -------------> <------------------------- control frame --------------------------->
 
 - a0..an: arguments
 - l0..ln: local variables
 - self: self value
-- flag: various infomation of current context.
-- precfp: cfp of previous frame (always on the stack)
+- precfp: cfp of the previous frame (always on the stack)
+- lfp: local frame pointer (on the stack or heap)
+- flg: various infomation of current context.
 - mfp: method frame pointer (on the stack or heap)
 - dfp: outer frame pointer (on the stack or heap)
 - pc: current program counter (on iseq)
+- heap: if this frame has been moved to heap, this field points to the heap frame.
 - iseq: reference to a bytecode (instruction sequence)
-- lfp: local frame pointer (on the stack or heap)
 - block: a block which passed to current context by caller frame.
+
+## native method frame
+
+         lfp                            cfp                  sp
+          v                              v                    v
+     --+------+------+--+------+------+------+------+------+-----
+       |  a0  |  a1  |..|  an  | self |precfp| lfp  | flg  |
+     --+------+------+--+------+------+------+------+------+-----
+        <---- local frame ----> <----- control frame ----->
+
+- a0..an: arguments
+- self: self value
+- precfp: cfp of the previous frame (always on the stack)
+- lfp: local frame pointer (on the stack or heap)
+- flg: various infomation of current context.