Antlr upgrade to version 4.9.2, some inline comments

lutaml · May 4, 2022 · 2c2c8ae · 2c2c8ae
1 parent b37a1b3
commit 2c2c8ae
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 43 deletions.
diff --git a/.github/workflows/rake.yml b/.github/workflows/rake.yml
@@ -8,8 +8,7 @@ on:
 jobs:
  rake:
  name: test on ruby-${{ matrix.ruby }} ${{ matrix.os }}
- runs-on: ${{ matrix.os }}
-
+ runs-on: ${{ matrix.os }} 
  continue-on-error: ${{ matrix.experimental }}
  strategy:
  fail-fast: false

diff --git a/ext/express-parser/antlr4-upstream b/ext/express-parser/antlr4-upstream
diff --git a/ext/express-parser/antlr4.patch b/ext/express-parser/antlr4.patch
diff --git a/ext/express-parser/express_parser.cpp b/ext/express-parser/express_parser.cpp
@@ -265,14 +265,6 @@ class ContextProxy {
 public:
  ContextProxy(tree::ParseTree* orig) {
  this -> orig = orig;
-// if (orig != nullptr) {
-// for (auto it = orig -> children.begin(); it != orig -> children.end(); it ++) {
-// Object parseTree = ContextProxy::wrapParseTree(*it);
-// if (parseTree != Nil) {
-// children.push(parseTree);
-// }
-// }
-// }
  }
 
  tree::ParseTree* getOriginal() {
@@ -294,6 +286,11 @@ class ContextProxy {
  }
 
  Array getChildren() {
+// Note re memory management
+// It looks like it is critical to 'fill' children array each time when this method is called
+// When Ruby GC collects the array it also unmarks all its elements so it is not possible to reuse them
+// (without custom mark function ????)
+// This comment also applies to all methods returning Ruby Arrays below
  Array children;
  if (orig != nullptr) {
  for (auto it = orig -> children.begin(); it != orig -> children.end(); it ++) {
@@ -307,11 +304,6 @@ class ContextProxy {
  }
 
  Object getParent() {
-// if (parent == Nil) {
-// if (orig != nullptr) {
-// parent = ContextProxy::wrapParseTree(orig -> parent);
-// }
-// }
  return orig == nullptr ? Nil: wrapParseTree(orig -> parent) ;
  }
 
@@ -334,8 +326,6 @@ class ContextProxy {
 
 protected:
  tree::ParseTree* orig = nullptr;
-// Array children;
-// Object parent = Nil;
 };
 
 class TerminalNodeProxy : public ContextProxy {

diff --git a/ext/express-parser/extconf.rb b/ext/express-parser/extconf.rb
@@ -45,12 +45,10 @@
  end
 else
  require 'mkmf-rice'
-
  dir_config(extension_name)
 end
 
-$CPPFLAGS << " -std=c++17 -DANTLR4CPP_STATIC -DHAVE_CXX11 -g -fno-common -fno-omit-frame-pointer"
-#-fsanitize=address -fsanitize-address-use-after-scope $DLDFLAGS << " -fsanitize=address"
+$CPPFLAGS << " -std=c++17 -DANTLR4CPP_STATIC -DHAVE_CXX11 -fno-omit-frame-pointer"
 $INCFLAGS << " -I#{__dir__}/#{antlr4_src}"
 $srcs = []
 

diff --git a/lib/expressir/express/parser.rb b/lib/expressir/express/parser.rb
@@ -33,8 +33,11 @@ class Parser
  def self.from_file(file, skip_references: nil, include_source: nil)
  input = File.read(file)
 
+ # An important note re memory management
+ # parse, syntax, visitor methods return complex tree structures created in netive (C++) extension
+ # visit method references nodes and leaves of this structures but it is totally untransparent for Ruby GarbageCllector
+ # so in this class we keep those C++ structure marked for GC so theu are not freed 
  @parser = ::ExpressParser::Parser.parse(input)
-
  @parse_tree = @parser.syntax()
 
  @visitor = Visitor.new(@parser.tokens, include_source: include_source)