energy/cef/cef-application-config.go

//----------------------------------------
//
// Copyright © yanghy. All Rights Reserved.
//
// Licensed under GNU General Public License v3.0
//
//----------------------------------------

package cef

import (
	"github.com/energye/energy/common"
	. "github.com/energye/energy/consts"
	"github.com/energye/golcl/energy/tools"
	"github.com/energye/golcl/lcl/api"
	"os"
	"path/filepath"
)

// Application 支持的配置
type tCefApplicationConfig struct {
	frameworkDirPath         uintptr //string cef框架根目录
	resourcesDirPath         uintptr //string
	localesDirPath           uintptr //string
	cache                    uintptr //string
	userDataPath             uintptr //string
	language                 uintptr //string 语言设置
	localesRequired          uintptr //string 默认空,检查所有的语言环境 逗号分隔
	logFile                  uintptr //string
	mainBundlePath           uintptr //string 只对 darwin 启作用
	browseSubprocessPath     uintptr //string 只对 非darwin 启作用
	logSeverity              uintptr //uint32
	noSandbox                uintptr //bool
	disableZygote            uintptr //bool 只对 linux 启作用
	enableGPU                uintptr //bool
	singleProcess            uintptr //bool 进程启动模式,默认false true:单进程 false:多进程
	useMockKeyChain          uintptr //bool
	checkCEFFiles            uintptr //bool
	remoteDebuggingPort      uintptr //int32
	externalMessagePump      uintptr //bool
	multiThreadedMessageLoop uintptr //bool
	chromeRuntime            uintptr //bool
}

// 创建应用全局配置
func NewApplicationConfig() *tCefApplicationConfig {
	m := &tCefApplicationConfig{}
	m.SetFrameworkDirPath(Empty)
	m.SetResourcesDirPath(Empty)
	m.SetLocalesDirPath(Empty)
	m.SetCache(Empty)
	m.SetUserDataPath(Empty)
	m.SetLanguage(LANGUAGE_zh_CN)
	m.SetLocalesRequired(Empty)
	m.SetLogFile(Empty)
	m.SetMainBundlePath(Empty)
	m.SetBrowseSubprocessPath(Empty)
	m.SetLogSeverity(LOGSEVERITY_DISABLE)
	m.SetEnableGPU(enableGPU)
	m.SetSingleProcess(false)
	m.SetUseMockKeyChain(false)
	m.SetNoSandbox(true)
	m.SetDisableZygote(true)
	m.SetCheckCEFFiles(false)
	m.SetRemoteDebuggingPort(0)
	m.SetChromeRuntime(false)
	// 以下条件判断根据不同平台, 启动不同的窗口组件
	// ViewsFrameworkBrowserWindow 窗口组件,同时支持 Windows/Linux/MacOSX
	// LCL 窗口组件,同时支持 Windows/MacOSX, CEF版本<=106.xx时支持GTK2, CEF版本>=107.xx时默认开启GTK3且不支持GTK2和LCL提供的各种组件
	if common.IsLinux() { // (VF)View Framework 窗口
		// Linux CEF >= 107.xxx 版本以后，默认启用的GTK3，106及以前版本默认支持GTK2但无法正常输入中文
		// 强制使用GTK3方式，但又无法正常创建lcl组件到窗口中，该框架只对浏览器应用做封装
		// 所以初衷以浏览器应用建设为目标
		// Linux平台默认设置为false,将启用 ViewsFrameworkBrowserWindow 窗口
		m.SetExternalMessagePump(false)
		m.SetMultiThreadedMessageLoop(false)
	} else if common.IsDarwin() { // LCL窗口
		// MacOSX 在使用LCL窗口组件必须将ExternalMessagePump=true和MultiThreadedMessageLoop=false
		// 或同Linux一样使用ViewsFrameworkBrowserWindow窗口组件
		m.SetExternalMessagePump(true)
		m.SetMultiThreadedMessageLoop(false)
	} else { // LCL窗口
		//Windows
		m.SetExternalMessagePump(false)
		m.SetMultiThreadedMessageLoop(true)
	}
	return m
}

//设置 Chromium Framework 编译好的二进制包根目录
//
//默认当前目录
func (m *tCefApplicationConfig) SetFrameworkDirPath(s string) *tCefApplicationConfig {
	m.frameworkDirPath = api.PascalStr(s)
	return m
}

//设置资源目录，默认当前目录
func (m *tCefApplicationConfig) SetResourcesDirPath(s string) *tCefApplicationConfig {
	m.resourcesDirPath = api.PascalStr(s)
	return m
}

//设置本地语言目录，默认当前目录
func (m *tCefApplicationConfig) SetLocalesDirPath(s string) *tCefApplicationConfig {
	m.localesDirPath = api.PascalStr(s)
	return m
}

//设置缓存目录，默认当前目录
func (m *tCefApplicationConfig) SetCache(s string) *tCefApplicationConfig {
	m.cache = api.PascalStr(s)
	return m
}

//设置用户数据目录，默认当前目录
func (m *tCefApplicationConfig) SetUserDataPath(s string) *tCefApplicationConfig {
	m.userDataPath = api.PascalStr(s)
	return m
}

//设置进程模型，作用于linux-默认禁用
func (m *tCefApplicationConfig) SetDisableZygote(s bool) *tCefApplicationConfig {
	m.disableZygote = api.PascalBool(s)
	return m
}

//设置关闭沙盒-默认关闭
func (m *tCefApplicationConfig) SetNoSandbox(s bool) *tCefApplicationConfig {
	m.noSandbox = api.PascalBool(s)
	return m
}

//设置开启关闭GPU加速
func (m *tCefApplicationConfig) SetEnableGPU(s bool) *tCefApplicationConfig {
	enableGPU = s
	m.enableGPU = api.PascalBool(s)
	return m
}

//设置进程模式，true:单进程模式
func (m *tCefApplicationConfig) SetSingleProcess(s bool) *tCefApplicationConfig {
	SingleProcess = s
	m.singleProcess = api.PascalBool(s)
	return m
}

//设置使用模拟key chain
func (m *tCefApplicationConfig) SetUseMockKeyChain(s bool) *tCefApplicationConfig {
	m.useMockKeyChain = api.PascalBool(s)
	return m
}

//检测CEF文件默认不检测
func (m *tCefApplicationConfig) SetCheckCEFFiles(s bool) *tCefApplicationConfig {
	m.checkCEFFiles = api.PascalBool(s)
	return m
}

//设置语言
func (m *tCefApplicationConfig) SetLanguage(s LANGUAGE) *tCefApplicationConfig {
	m.language = api.PascalStr(string(s))
	return m
}

//设置必备的本地语言支持，逗号分隔的字符串 s="zh-CN,en-US" ,默认情况下 en-US 是必须的
func (m *tCefApplicationConfig) SetLocalesRequired(s string) *tCefApplicationConfig {
	m.localesRequired = api.PascalStr(s)
	return m
}

//设置日志文件目录
func (m *tCefApplicationConfig) SetLogFile(s string) *tCefApplicationConfig {
	m.logFile = api.PascalStr(s)
	return m
}

//设置主程序绑定目录 作用于macos
func (m *tCefApplicationConfig) SetMainBundlePath(s string) *tCefApplicationConfig {
	m.mainBundlePath = api.PascalStr(s)
	return m
}

//设置子进程执行文件目录，一搬用于主进程过于复杂启动慢，需要独立出子进程
func (m *tCefApplicationConfig) SetBrowseSubprocessPath(s string) *tCefApplicationConfig {
	m.browseSubprocessPath = api.PascalStr(s)
	return m
}

//设置日志级别
func (m *tCefApplicationConfig) SetLogSeverity(s LOG) *tCefApplicationConfig {
	m.logSeverity = uintptr(s)
	return m
}

//设置远程调式端口 (1024 ~ 65535)
func (m *tCefApplicationConfig) SetRemoteDebuggingPort(s int32) *tCefApplicationConfig {
	if s > 1024 && s < 65535 {
		m.remoteDebuggingPort = uintptr(s)
	}
	return m
}

func (m *tCefApplicationConfig) SetExternalMessagePump(s bool) *tCefApplicationConfig {
	m.externalMessagePump = api.PascalBool(s)
	return m
}

func (m *tCefApplicationConfig) SetMultiThreadedMessageLoop(s bool) *tCefApplicationConfig {
	m.multiThreadedMessageLoop = api.PascalBool(s)
	return m
}

func (m *tCefApplicationConfig) SetChromeRuntime(s bool) *tCefApplicationConfig {
	m.chromeRuntime = api.PascalBool(s)
	return m
}

// GO绑定JS通用类型所属对象名定义
//
//默认值  gocobj
func (m *tCefApplicationConfig) SetCommonRootName(name string) {
	if name == "" {
		name = commonRootName
	} else {
		commonRootName = name
	}
	common.Proc(internale_CEFV8ValueRef_SetCommonRootName).Call(api.PascalStr(commonRootName))
}

// GO绑定JS对象类型所属对象名定义
//
//默认值 goobj
func (m *tCefApplicationConfig) SetObjectRootName(name string) {
	if name == "" {
		name = objectRootName
	} else {
		objectRootName = name
	}
	common.Proc(internale_CEFV8ValueRef_SetObjectRootName).Call(api.PascalStr(objectRootName))
}

//energy framework env
func (m *tCefApplicationConfig) framework() {
	var path string
	if m.frameworkDirPath == 0 {
		path = libPath()
	} else {
		path = api.GoStr(m.frameworkDirPath)
	}
	if path != "" {
		m.SetFrameworkDirPath(path)
		if m.cache == 0 {
			m.SetCache(filepath.Join(path, "cache"))
		}
		if m.userDataPath == 0 {
			m.SetUserDataPath(filepath.Join(path, "userDataPath"))
		}
	}
}

func ceflib() string {
	if common.IsWindows() {
		return "libcef.dll"
	} else if common.IsLinux() {
		return "libcef.so"
	}
	return ""
}

func libPath() string {
	var lib = ceflib()
	if lib != "" {
		//当前目录
		if tools.IsExist(ExePath + Separator + lib) {
			return ExePath
		}
		//环境变量
		var env = os.Getenv(ENERGY_HOME_KEY)
		if tools.IsExist(env + Separator + lib) {
			return env
		}
	}
	return ""
}