Proper inheritance model with DIScope

Signed-off-by: Vihan <[email protected]>

Author: vihanb

index.js

@@ -1 +1 @@
-module.exports = require("bindings")("llvm-node.node");
+module.exports = require("bindings")("llvm-node.node");

llvm-node.d.ts

@@ -268,7 +268,11 @@ declare namespace llvm {
 
   }
 
-  class DIFile {
+  class DIFile extends DIScope {
+    private constructor();
+  }
+
+  class DIScope {
     readonly filename: string;
     readonly directory: string;
 

src/ir/di-file.cc

@@ -6,9 +6,7 @@ NAN_MODULE_INIT(DIFileWrapper::Init) {
     v8::Local<v8::FunctionTemplate> tpl = Nan::New<v8::FunctionTemplate>(New);
     tpl->SetClassName(Nan::New("DIFile").ToLocalChecked());
     tpl->InstanceTemplate()->SetInternalFieldCount(1);
-
-    Nan::SetAccessor(tpl->InstanceTemplate(), Nan::New("filename").ToLocalChecked(), DIFileWrapper::getFilename);
-    Nan::SetAccessor(tpl->InstanceTemplate(), Nan::New("directory").ToLocalChecked(), DIFileWrapper::getDirectory);
+    tpl->Inherit(Nan::New(DIScopeWrapper::functionTemplate));
 
     functionTemplate.Reset(tpl);
 
@@ -34,18 +32,6 @@ NAN_METHOD(DIFileWrapper::New) {
     info.GetReturnValue().Set(info.This());
 }
 
-NAN_GETTER(DIFileWrapper::getFilename) {
-    auto* wrapper = DIFileWrapper::FromValue(info.Holder())->getDIFile();
-    auto result = Nan::New(wrapper->getFilename().str()).ToLocalChecked();
-    info.GetReturnValue().Set(result);
-}
-
-NAN_GETTER(DIFileWrapper::getDirectory) {
-    auto* wrapper = DIFileWrapper::FromValue(info.Holder())->getDIFile();
-    auto result = Nan::New(wrapper->getDirectory().str()).ToLocalChecked();
-    info.GetReturnValue().Set(result);
-}
-
 v8::Local<v8::Object> DIFileWrapper::of(llvm::DIFile *file) {
     v8::Local<v8::FunctionTemplate> localFunctionTemplate = Nan::New(functionTemplate);
     v8::Local<v8::Object> object = Nan::NewInstance(localFunctionTemplate->InstanceTemplate()).ToLocalChecked();
@@ -58,7 +44,7 @@ v8::Local<v8::Object> DIFileWrapper::of(llvm::DIFile *file) {
 }
 
 llvm::DIFile *DIFileWrapper::getDIFile() {
-    return this->diFile;
+    return static_cast<llvm::DIFile*>(getDIScope());
 }
 
 bool DIFileWrapper::isInstance(v8::Local<v8::Value> value) {

src/ir/di-file.h

@@ -5,28 +5,25 @@
 #include <llvm/IR/DebugInfoMetadata.h>
 #include <nan_callbacks_12_inl.h>
 #include "../util/from-value-mixin.h"
+#include "di-scope.h"
 
-class DIFileWrapper: public Nan::ObjectWrap, public FromValueMixin<DIFileWrapper> {
+class DIFileWrapper: public DIScopeWrapper, public FromValueMixin<DIFileWrapper> {
 public:
     static NAN_MODULE_INIT(Init);
     static v8::Local<v8::Object> of(llvm::DIFile *diFile);
 
+    using FromValueMixin<DIFileWrapper>::FromValue;
+
     static bool isInstance(v8::Local<v8::Value> value);
 
     llvm::DIFile *getDIFile();
 
 private:
-    llvm::DIFile *diFile;
-
-    explicit DIFileWrapper(llvm::DIFile *diFile) : diFile { diFile } {
+    explicit DIFileWrapper(llvm::DIFile *diFile) : DIScopeWrapper { diFile } {
     }
 
     static NAN_METHOD(New);
 
-    // instance
-    static NAN_GETTER(getFilename);
-    static NAN_GETTER(getDirectory);
-
     static Nan::Persistent<v8::FunctionTemplate> functionTemplate;
 };
 

src/ir/di-scope.cc

@@ -0,0 +1,68 @@
+#include "di-scope.h"
+
+Nan::Persistent<v8::FunctionTemplate> DIScopeWrapper::functionTemplate {};
+
+NAN_MODULE_INIT(DIScopeWrapper::Init) {
+    v8::Local<v8::FunctionTemplate> tpl = Nan::New<v8::FunctionTemplate>(New);
+    tpl->SetClassName(Nan::New("DIScope").ToLocalChecked());
+    tpl->InstanceTemplate()->SetInternalFieldCount(1);
+
+    Nan::SetAccessor(tpl->InstanceTemplate(), Nan::New("filename").ToLocalChecked(), DIScopeWrapper::getFilename);
+    Nan::SetAccessor(tpl->InstanceTemplate(), Nan::New("directory").ToLocalChecked(), DIScopeWrapper::getDirectory);
+
+    functionTemplate.Reset(tpl);
+
+    Nan::Set(target, Nan::New("DIScope").ToLocalChecked(), Nan::GetFunction(tpl).ToLocalChecked());
+}
+
+
+NAN_METHOD(DIScopeWrapper::New) {
+    if (!info.IsConstructCall())
+    {
+        return Nan::ThrowTypeError("Class Constructor Value cannot be invoked without new");
+    }
+
+    if (info.Length() != 1 || !info[0]->IsExternal())
+    {
+        return Nan::ThrowTypeError("External Value Pointer required");
+    }
+
+    llvm::DIScope *scope = static_cast<llvm::DIScope *>(v8::External::Cast(*info[0])->Value());
+    auto *wrapper = new DIScopeWrapper { scope };
+
+    wrapper->Wrap(info.This());
+    info.GetReturnValue().Set(info.This());
+}
+
+NAN_GETTER(DIScopeWrapper::getFilename) {
+    auto* wrapper = DIScopeWrapper::FromValue(info.Holder())->getDIScope();
+    auto result = Nan::New(wrapper->getFilename().str()).ToLocalChecked();
+
+    info.GetReturnValue().Set(result);
+}
+
+NAN_GETTER(DIScopeWrapper::getDirectory) {
+    auto* wrapper = DIScopeWrapper::FromValue(info.Holder())->getDIScope();
+    auto result = Nan::New(wrapper->getDirectory().str()).ToLocalChecked();
+
+    info.GetReturnValue().Set(result);
+}
+
+v8::Local<v8::Object> DIScopeWrapper::of(llvm::DIScope *scope) {
+    v8::Local<v8::FunctionTemplate> localFunctionTemplate = Nan::New(functionTemplate);
+    v8::Local<v8::Object> object = Nan::NewInstance(localFunctionTemplate->InstanceTemplate()).ToLocalChecked();
+
+    DIScopeWrapper* wrapper = new DIScopeWrapper { scope };
+    wrapper->Wrap(object);
+
+    Nan::EscapableHandleScope escapeScope {};
+    return escapeScope.Escape(object);
+}
+
+llvm::DIScope *DIScopeWrapper::getDIScope() {
+    return this->scope;
+}
+
+bool DIScopeWrapper::isInstance(v8::Local<v8::Value> value) {
+    return Nan::New(functionTemplate)->HasInstance(value);
+}

src/ir/di-scope.h

@@ -0,0 +1,34 @@
+#ifndef LLVM_NODE_DI_SCOPE_H
+#define LLVM_NODE_DI_SCOPE_H
+
+#include <nan.h>
+#include <llvm/IR/DebugInfoMetadata.h>
+#include <nan_callbacks_12_inl.h>
+#include "../util/from-value-mixin.h"
+
+class DIScopeWrapper: public Nan::ObjectWrap, public FromValueMixin<DIScopeWrapper> {
+public:
+    static NAN_MODULE_INIT(Init);
+    static v8::Local<v8::Object> of(llvm::DIScope *scope);
+
+    static bool isInstance(v8::Local<v8::Value> value);
+
+    llvm::DIScope *getDIScope();
+
+protected:
+    explicit DIScopeWrapper(llvm::DIScope *scope) : scope { scope } {
+    }
+
+    static Nan::Persistent<v8::FunctionTemplate> functionTemplate;
+
+private:
+    llvm::DIScope *scope;
+
+    static NAN_METHOD(New);
+
+    // instance
+    static NAN_GETTER(getFilename);
+    static NAN_GETTER(getDirectory);
+};
+
+#endif //LLVM_NODE_DI_SCOPE_H

src/ir/ir.cc

@@ -9,6 +9,7 @@
 #include "di-builder.h"
 #include "di-file.h"
 #include "di-compile-unit.h"
+#include "di-scope.h"
 #include "module.h"
 #include "llvm-context.h"
 #include "type.h"
@@ -60,13 +61,14 @@ NAN_MODULE_INIT(InitIR) {
     ConstantIntWrapper::Init(target);
     ConstantPointerNullWrapper::Init(target);
     DataLayoutWrapper::Init(target);
+    DIBuilderWrapper::Init(target);
+    DICompileUnitWrapper::Init(target);
+    DIScopeWrapper::Init(target);
+    DIFileWrapper::Init(target);
     FunctionWrapper::Init(target);
     FunctionTypeWrapper::Init(target);
     GlobalVariableWrapper::Init(target);
     IRBuilderWrapper::Init(target);
-    DIBuilderWrapper::Init(target);
-    DIFileWrapper::Init(target);
-    DICompileUnitWrapper::Init(target);
     InitLinkageTypes(target);
     IntegerTypeWrapper::Init(target);
     ModuleWrapper::Init(target);