cefpython/cefpython/cefpython.pyx at 716671ac1145022dd2ec3885892ae105eb5a69fa · noanti/cefpython

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

# License: New BSD License.

# Website: http://code.google.com/p/cefpython/

# IMPORTANT notes:

# - cdef/cpdef functions returning something other than a Python object

# should have in its declaration "except *", otherwise exceptions are

# ignored. Those cdef/cpdef that return "object" have "except *" by

# default. The setup/compile.py script will check for functions missing

# "except *" and will display an error message about that, but it's

# not perfect and won't detect all cases.

# - TODO: add checking for "except * with gil" in functions with the

# "public" keyword

# - about acquiring/releasing GIL lock, see discussion here:

# https://groups.google.com/forum/?fromgroups=#!topic/cython-users/jcvjpSOZPp0

# - <CefRefPtr[ClientHandler]?>new ClientHandler()

# <...?> means to throw an error if the cast is not allowed

# - in client handler callbacks (or others that are called from C++ and

# use "except * with gil") must embrace all code in try..except otherwise

# the error will be ignored, only printed to the output console, this is the

# default behavior of Cython, to remedy this you are supposed to add "except *"

# in function declaration, unfortunately it does not work, some conflict with

# CEF threading, see topic at cython-users for more details:

# https://groups.google.com/d/msg/cython-users/CRxWoX57dnM/aufW3gXMhOUJ.

# - CTags requires all functions/methods imported in .pxd files to be preceded with "cdef",

# otherwise they are not indexed.

# - __del__ method does not exist in Extension Types (cdef class),

# you have to use __dealloc__ instead, try to remember that as

# defining __del__ will not raise any warning and could lead to

# memory leaks.

# - CefString.c_str() is safe to use only on Windows, on Ubuntu 64bit

# for a "Pers" string it returns: "P\x00e\x00r\x00s\x00", which is

# most probably not what you expected.

# - You can rename methods when importing in pxd files:

# | cdef cppclass _Object "Object":

# - Supporting operators that are not yet supported:

# | CefRefPtr[T]& Assign "operator="(T* p)

# | cefBrowser.Assign(CefBrowser*)

# In the same way you can import function with a different name, this one

# imports a static method Create() while adding a prefix "CefSome_":

# | cdef extern from "..":

# | static CefRefPtr[CefSome] CefSome_Create "CefSome::Create"()

# - Declaring C++ classes in Cython. Storing python callbacks

# in a C++ class using Py_INCREF, Py_DECREF. Calling from

# C++ using PyObject_CallMethod.

# | http://stackoverflow.com/a/17070382/623622

# Disadvantage: when calling python callback from the C++ class

# declared in Cython there is no easy way to propagate the python

# exceptions when they occur during execution of the callback.

# - | cdef char* other_c_string = py_string

# This is a very fast operation after which other_c_string points

# to the byte string buffer of the Python string itself. It is

# tied to the life time of the Python string. When the Python

# string is garbage collected, the pointer becomes invalid.

# - Do not define cpdef functions returning "cpp_bool":

# | cpdef cpp_bool myfunc() except *:

# This causes compiler warnings like this:

# | cefpython.cpp(26533) : warning C4800: 'int' : forcing value

# | to bool 'true' or 'false' (performance warning)

# Do instead declare "py_bool" as return type:

# | cpdef py_bool myufunc():

# Lots of these warnings results in ignoring them, but sometimes

# they are shown for a good reason, for example when you forget

# to return a value in a function.

# - Always import bool from libcpp as cpp_bool, if you import it as

# "bool" in a pxd file, then Cython will complain about bool casts

# like "bool(1)" being invalid, in pyx files.

# Global variables.

g_debug = False

g_debugFile = None

# When put None here and assigned a local dictionary in Initialize(), later while

# running app this global variable was garbage collected, see topic:

# https://groups.google.com/d/topic/cython-users/0dw3UASh7HY/discussion

g_applicationSettings = {}

cdef dict g_globalClientCallbacks = {}

# All .pyx files need to be included here.

include "cython_includes/compile_time_constants.pxi"

include "imports.pyx"

include "utils.pyx"

include "string_utils.pyx"

IF UNAME_SYSNAME == "Windows":

include "string_utils_win.pyx"

include "time_utils.pyx"

include "browser.pyx"

include "frame.pyx"

include "settings.pyx"

IF UNAME_SYSNAME == "Windows" and CEF_VERSION == 1:

# Off-screen rendering currently supported only on Windows

include "paint_buffer_cef1.pyx"

IF UNAME_SYSNAME == "Windows":

include "window_utils_win.pyx"

IF CEF_VERSION == 1:

include "http_authentication_win.pyx"

ELIF UNAME_SYSNAME == "Linux":

include "window_utils_linux.pyx"

include "javascript_bindings.pyx"

include "virtual_keys.pyx"

IF CEF_VERSION == 1:

include "window_info_cef1.pyx"

include "cookie_cef1.pyx"

include "load_handler_cef1.pyx"

include "keyboard_handler_cef1.pyx"

include "request_cef1.pyx"

include "web_request_cef1.pyx"

include "stream.pyx"

include "content_filter.pyx"

include "request_handler_cef1.pyx"

include "response_cef1.pyx"

include "display_handler_cef1.pyx"

include "lifespan_handler_cef1.pyx"

IF UNAME_SYSNAME == "Windows":

# Off-screen rendering currently supported only on Windows.

include "render_handler_cef1.pyx"

include "drag_data.pyx"

include "drag_handler.pyx"

include "download_handler.pyx"

include "v8context_handler_cef1.pyx"

include "v8function_handler_cef1.pyx"

include "v8utils_cef1.pyx"

include "javascript_callback_cef1.pyx"

include "python_callback_cef1.pyx"

include "network_error_cef1.pyx"

IF CEF_VERSION == 3:

include "window_info_cef3.pyx"

include "process_message_utils.pyx"

include "v8context_handler_cef3.pyx"

include "v8function_handler_cef3.pyx"

include "javascript_callback_cef3.pyx"

include "python_callback_cef3.pyx"

include "lifespan_handler_cef3.pyx"

include "display_handler_cef3.pyx"

include "keyboard_handler_cef3.pyx"

include "web_plugin_info_cef3.pyx"

include "request_cef3.pyx"

include "request_handler_cef3.pyx"

include "cookie_cef3.pyx"

include "string_visitor_cef3.pyx"

include "load_handler_cef3.pyx"

include "network_error_cef3.pyx"

include "browser_process_handler_cef3.pyx"

include "paint_buffer_cef3.pyx"

include "render_handler_cef3.pyx"

include "callback_cef3.pyx"

include "resource_handler_cef3.pyx"

include "response_cef3.pyx"

include "web_request_cef3.pyx"

# Try not to run any of the CEF code until Initialize() is called.

# Do not allocate any memory on the heap until Initialize() is called,

# that's why we're not instantiating the ClientHandler class here in

# the declaration. CEF hooks up its own tcmalloc globally when the

# library is loaded, but the memory allocation implementation may still

# be changed by another library (wx/gtk) before Initialize() is called.

cdef CefRefPtr[ClientHandler] g_clientHandler

def Initialize(applicationSettings=None):

Debug("-" * 60)

Debug("Initialize() called")

global g_clientHandler

if not g_clientHandler.get():

g_clientHandler = <CefRefPtr[ClientHandler]?>new ClientHandler()

cdef CefRefPtr[CefApp] cefApp

IF CEF_VERSION == 3:

cefApp = <CefRefPtr[CefApp]?>new CefPythonApp()

IF UNAME_SYSNAME == "Windows":

cdef HINSTANCE hInstance = GetModuleHandle(NULL)

cdef CefMainArgs cefMainArgs = CefMainArgs(hInstance)

ELIF UNAME_SYSNAME == "Linux":

# TODO: use the CefMainArgs(int argc, char** argv) constructor.

cdef CefMainArgs cefMainArgs

cdef int exitCode = CefExecuteProcess(cefMainArgs, cefApp)

Debug("CefExecuteProcess(): exitCode = %s" % exitCode)

if exitCode >= 0:

sys.exit(exitCode)

if not applicationSettings:

applicationSettings = {}

if not "multi_threaded_message_loop" in applicationSettings:

applicationSettings["multi_threaded_message_loop"] = False

if not "string_encoding" in applicationSettings:

applicationSettings["string_encoding"] = "utf-8"

IF CEF_VERSION == 3:

if not "single_process" in applicationSettings:

applicationSettings["single_process"] = False

# We must make a copy as applicationSettings is a reference only that might get destroyed.

global g_applicationSettings

for key in applicationSettings:

g_applicationSettings[key] = copy.deepcopy(applicationSettings[key])

cdef CefSettings cefApplicationSettings

SetApplicationSettings(applicationSettings, &cefApplicationSettings)

Debug("CefInitialize()")

cdef cpp_bool ret

IF CEF_VERSION == 1:

ret = CefInitialize(cefApplicationSettings, cefApp)

ELIF CEF_VERSION == 3:

ret = CefInitialize(cefMainArgs, cefApplicationSettings, cefApp)

if not ret: Debug("CefInitialize() failed")

return ret

def CreateBrowserSync(windowInfo, browserSettings, navigateUrl):

Debug("CreateBrowserSync() called")

assert IsThread(TID_UI), (

"cefpython.CreateBrowserSync() may only be called on the UI thread")

if not isinstance(windowInfo, WindowInfo):

raise Exception("CreateBrowserSync() failed: windowInfo: invalid object")

cdef CefBrowserSettings cefBrowserSettings

SetBrowserSettings(browserSettings, &cefBrowserSettings)

cdef CefWindowInfo cefWindowInfo

SetCefWindowInfo(cefWindowInfo, windowInfo)

navigateUrl = GetNavigateUrl(navigateUrl)

Debug("navigateUrl: %s" % navigateUrl)

cdef CefString cefNavigateUrl

PyToCefString(navigateUrl, cefNavigateUrl)

Debug("CefBrowser::CreateBrowserSync()")

global g_clientHandler

cdef CefRefPtr[CefBrowser] cefBrowser = cef_browser_static.CreateBrowserSync(

cefWindowInfo, <CefRefPtr[CefClient]?>g_clientHandler, cefNavigateUrl,

cefBrowserSettings)

if <void*>cefBrowser == NULL:

Debug("CefBrowser::CreateBrowserSync() failed")

return None

else:

Debug("CefBrowser::CreateBrowserSync() succeeded")

cdef PyBrowser pyBrowser = GetPyBrowser(cefBrowser)

pyBrowser.SetUserData("__outerWindowHandle", int(windowInfo.parentWindowHandle))

# IF CEF_VERSION == 3:

# Test whether process message sent before renderer thread is created

# will be delivered - OK.

# Debug("Sending 'CreateBrowserSync() done' message to the Renderer")

# pyBrowser.SendProcessMessage(cef_types.PID_RENDERER,

# "CreateBrowserSync() done")

return pyBrowser

def MessageLoop():

Debug("MessageLoop()")

with nogil:

CefRunMessageLoop()

def MessageLoopWork():

# Perform a single iteration of CEF message loop processing.

# This function is used to integrate the CEF message loop

# into an existing application message loop.

# Anything that can block for a significant amount of time

# and is thread-safe should release the GIL:

# https://groups.google.com/d/msg/cython-users/jcvjpSOZPp0/KHpUEX8IhnAJ

# GIL must be released here otherwise we will get dead lock

# when calling from c++ to python.

with nogil:

CefDoMessageLoopWork();

def SingleMessageLoop():

# @deprecated, use MessageLoopWork() instead

MessageLoopWork()

def QuitMessageLoop():

Debug("QuitMessageLoop()")

CefQuitMessageLoop()

def Shutdown():

Debug("Shutdown()")

CefShutdown()

def SetOsModalLoop(py_bool modalLoop):

CefSetOSModalLoop(bool(modalLoop))

cpdef py_void SetGlobalClientCallback(py_string name, object callback):

global g_globalClientCallbacks

if name in ["OnCertificateError", "OnBeforePluginLoad"]:

g_globalClientCallbacks[name] = callback

else:

raise Exception("SetGlobalClientCallback() failed: " \

"invalid callback name = %s" % name)

cpdef object GetGlobalClientCallback(py_string name):

global g_globalClientCallbacks

if name in g_globalClientCallbacks:

return g_globalClientCallbacks[name]

else:

return None

FilesExpand file tree

cefpython.pyx

Latest commit

History

cefpython.pyx

File metadata and controls