mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Improve inheritance support in the CEF API (issue #1623).
- Support single parent inheritance in CEF API classes. - Support non-virtual inheritance in CEF API classes. - Support translation of CEF API sub-directories. - Add test sub-directories for testing-only functionality that will be available to unit tests but not exposed via the binary distribution. - Add unit tests for the translator tool. - Fix parsing of template parameter types that include commas.
This commit is contained in:
@@ -10,63 +10,31 @@
|
||||
#include "include/base/cef_macros.h"
|
||||
#include "include/cef_base.h"
|
||||
#include "include/capi/cef_base_capi.h"
|
||||
#include "libcef_dll/wrapper_types.h"
|
||||
|
||||
// Wrap a C structure with a C++ class. This is used when the implementation
|
||||
// Wrap a C structure with a C++ class. This is used when the implementation
|
||||
// exists on the other side of the DLL boundary but will have methods called on
|
||||
// this side of the DLL boundary.
|
||||
template <class ClassName, class BaseName, class StructName>
|
||||
class CefCToCpp : public BaseName {
|
||||
public:
|
||||
// Use this method to create a wrapper class instance for a structure
|
||||
// received from the other side.
|
||||
static CefRefPtr<BaseName> Wrap(StructName* s) {
|
||||
if (!s)
|
||||
return NULL;
|
||||
// Create a new wrapper instance for a structure reference received from the
|
||||
// other side.
|
||||
static CefRefPtr<BaseName> Wrap(StructName* s);
|
||||
|
||||
// Wrap their structure with the CefCToCpp object.
|
||||
ClassName* wrapper = new ClassName(s);
|
||||
// Put the wrapper object in a smart pointer.
|
||||
CefRefPtr<BaseName> wrapperPtr(wrapper);
|
||||
// Release the reference that was added to the CefCppToC wrapper object on
|
||||
// the other side before their structure was passed to us.
|
||||
wrapper->UnderlyingRelease();
|
||||
// Return the smart pointer.
|
||||
return wrapperPtr;
|
||||
}
|
||||
|
||||
// Use this method to retrieve the underlying structure from a wrapper class
|
||||
// instance for return back to the other side.
|
||||
static StructName* Unwrap(CefRefPtr<BaseName> c) {
|
||||
if (!c.get())
|
||||
return NULL;
|
||||
|
||||
// Cast the object to our wrapper class type.
|
||||
ClassName* wrapper = static_cast<ClassName*>(c.get());
|
||||
// Add a reference to the CefCppToC wrapper object on the other side that
|
||||
// will be released once the structure is received.
|
||||
wrapper->UnderlyingAddRef();
|
||||
// Return their original structure.
|
||||
return wrapper->GetStruct();
|
||||
}
|
||||
|
||||
explicit CefCToCpp(StructName* str)
|
||||
: struct_(str) {
|
||||
DCHECK(str);
|
||||
|
||||
#ifndef NDEBUG
|
||||
base::AtomicRefCountInc(&DebugObjCt);
|
||||
#endif
|
||||
}
|
||||
virtual ~CefCToCpp() {
|
||||
#ifndef NDEBUG
|
||||
base::AtomicRefCountDec(&DebugObjCt);
|
||||
#endif
|
||||
}
|
||||
// Retrieve the underlying structure reference from a wrapper instance for
|
||||
// return back to the other side.
|
||||
static StructName* Unwrap(CefRefPtr<BaseName> c);
|
||||
|
||||
// If returning the structure across the DLL boundary you should call
|
||||
// UnderlyingAddRef() on this wrapping CefCToCpp object. On the other side of
|
||||
// the DLL boundary, call Release() on the CefCppToC object.
|
||||
StructName* GetStruct() { return struct_; }
|
||||
// the DLL boundary, call Release() on the CefCppToC object.
|
||||
StructName* GetStruct() const {
|
||||
WrapperStruct* wrapperStruct = GetWrapperStruct(this);
|
||||
// Verify that the wrapper offset was calculated correctly.
|
||||
DCHECK_EQ(kWrapperType, wrapperStruct->type_);
|
||||
return wrapperStruct->struct_;
|
||||
}
|
||||
|
||||
// CefBase methods increment/decrement reference counts on both this object
|
||||
// and the underlying wrapped structure.
|
||||
@@ -74,31 +42,8 @@ class CefCToCpp : public BaseName {
|
||||
UnderlyingAddRef();
|
||||
ref_count_.AddRef();
|
||||
}
|
||||
bool Release() const {
|
||||
UnderlyingRelease();
|
||||
if (ref_count_.Release()) {
|
||||
delete this;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
bool HasOneRef() const { return ref_count_.HasOneRef(); }
|
||||
|
||||
// Increment/decrement reference counts on only the underlying class.
|
||||
void UnderlyingAddRef() const {
|
||||
if (struct_->base.add_ref)
|
||||
struct_->base.add_ref(&struct_->base);
|
||||
}
|
||||
bool UnderlyingRelease() const {
|
||||
if (!struct_->base.release)
|
||||
return false;
|
||||
return struct_->base.release(&struct_->base) ? true : false;
|
||||
}
|
||||
bool UnderlyingHasOneRef() const {
|
||||
if (!struct_->base.has_one_ref)
|
||||
return false;
|
||||
return struct_->base.has_one_ref(&struct_->base) ? true : false;
|
||||
}
|
||||
bool Release() const;
|
||||
bool HasOneRef() const { return UnderlyingHasOneRef(); }
|
||||
|
||||
#ifndef NDEBUG
|
||||
// Simple tracking of allocated objects.
|
||||
@@ -106,12 +51,125 @@ class CefCToCpp : public BaseName {
|
||||
#endif
|
||||
|
||||
protected:
|
||||
StructName* struct_;
|
||||
CefCToCpp() {
|
||||
#ifndef NDEBUG
|
||||
base::AtomicRefCountInc(&DebugObjCt);
|
||||
#endif
|
||||
}
|
||||
|
||||
virtual ~CefCToCpp() {
|
||||
#ifndef NDEBUG
|
||||
base::AtomicRefCountDec(&DebugObjCt);
|
||||
#endif
|
||||
}
|
||||
|
||||
private:
|
||||
// Used to associate this wrapper object and the structure reference received
|
||||
// from the other side.
|
||||
struct WrapperStruct;
|
||||
|
||||
static WrapperStruct* GetWrapperStruct(const BaseName* obj);
|
||||
|
||||
// Unwrap as the derived type.
|
||||
static StructName* UnwrapDerived(CefWrapperType type, BaseName* c);
|
||||
|
||||
// Increment/decrement reference counts on only the underlying class.
|
||||
void UnderlyingAddRef() const {
|
||||
cef_base_t* base = reinterpret_cast<cef_base_t*>(GetStruct());
|
||||
if (base->add_ref)
|
||||
base->add_ref(base);
|
||||
}
|
||||
|
||||
bool UnderlyingRelease() const {
|
||||
cef_base_t* base = reinterpret_cast<cef_base_t*>(GetStruct());
|
||||
if (!base->release)
|
||||
return false;
|
||||
return base->release(base) ? true : false;
|
||||
}
|
||||
|
||||
bool UnderlyingHasOneRef() const {
|
||||
cef_base_t* base = reinterpret_cast<cef_base_t*>(GetStruct());
|
||||
if (!base->has_one_ref)
|
||||
return false;
|
||||
return base->has_one_ref(base) ? true : false;
|
||||
}
|
||||
|
||||
CefRefCount ref_count_;
|
||||
|
||||
static CefWrapperType kWrapperType;
|
||||
|
||||
DISALLOW_COPY_AND_ASSIGN(CefCToCpp);
|
||||
};
|
||||
|
||||
template <class ClassName, class BaseName, class StructName>
|
||||
struct CefCToCpp<ClassName,BaseName,StructName>::WrapperStruct {
|
||||
CefWrapperType type_;
|
||||
StructName* struct_;
|
||||
ClassName wrapper_;
|
||||
};
|
||||
|
||||
template <class ClassName, class BaseName, class StructName>
|
||||
CefRefPtr<BaseName>
|
||||
CefCToCpp<ClassName, BaseName, StructName>::Wrap(StructName* s) {
|
||||
if (!s)
|
||||
return NULL;
|
||||
|
||||
// Wrap their structure with the CefCToCpp object.
|
||||
WrapperStruct* wrapperStruct = new WrapperStruct;
|
||||
wrapperStruct->type_ = kWrapperType;
|
||||
wrapperStruct->struct_ = s;
|
||||
|
||||
// Put the wrapper object in a smart pointer.
|
||||
CefRefPtr<BaseName> wrapperPtr(&wrapperStruct->wrapper_);
|
||||
// Release the reference that was added to the CefCppToC wrapper object on
|
||||
// the other side before their structure was passed to us.
|
||||
wrapperStruct->wrapper_.UnderlyingRelease();
|
||||
// Return the smart pointer.
|
||||
return wrapperPtr;
|
||||
}
|
||||
|
||||
template <class ClassName, class BaseName, class StructName>
|
||||
StructName*
|
||||
CefCToCpp<ClassName, BaseName, StructName>::Unwrap(CefRefPtr<BaseName> c) {
|
||||
if (!c.get())
|
||||
return NULL;
|
||||
|
||||
WrapperStruct* wrapperStruct = GetWrapperStruct(c.get());
|
||||
|
||||
// If the type does not match this object then we need to unwrap as the
|
||||
// derived type.
|
||||
if (wrapperStruct->type_ != kWrapperType)
|
||||
return UnwrapDerived(wrapperStruct->type_, c.get());
|
||||
|
||||
// Add a reference to the CefCppToC wrapper object on the other side that
|
||||
// will be released once the structure is received.
|
||||
wrapperStruct->wrapper_.UnderlyingAddRef();
|
||||
// Return their original structure.
|
||||
return wrapperStruct->struct_;
|
||||
}
|
||||
|
||||
template <class ClassName, class BaseName, class StructName>
|
||||
bool CefCToCpp<ClassName, BaseName, StructName>::Release() const {
|
||||
UnderlyingRelease();
|
||||
if (ref_count_.Release()) {
|
||||
WrapperStruct* wrapperStruct = GetWrapperStruct(this);
|
||||
// Verify that the wrapper offset was calculated correctly.
|
||||
DCHECK_EQ(kWrapperType, wrapperStruct->type_);
|
||||
delete wrapperStruct;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
template <class ClassName, class BaseName, class StructName>
|
||||
typename CefCToCpp<ClassName, BaseName, StructName>::WrapperStruct*
|
||||
CefCToCpp<ClassName, BaseName, StructName>::GetWrapperStruct(
|
||||
const BaseName* obj) {
|
||||
// Offset using the WrapperStruct size instead of individual member sizes to
|
||||
// avoid problems due to platform/compiler differences in structure padding.
|
||||
return reinterpret_cast<WrapperStruct*>(
|
||||
reinterpret_cast<char*>(const_cast<BaseName*>(obj)) -
|
||||
(sizeof(WrapperStruct) - sizeof(ClassName)));
|
||||
}
|
||||
|
||||
#endif // CEF_LIBCEF_DLL_CTOCPP_CTOCPP_H_
|
||||
|
Reference in New Issue
Block a user