Source.Python/docs/_modules/memory.html at master · Source-Python-Dev-Team/Source.Python · GitHub

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

<!DOCTYPE html>

<head>

<title>memory — Source.Python v743 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">memory</a></li>

</ul>

</div>

<h1>Source code for memory</h1><div class="highlight"><pre>

# ../memory/__init__.py

"""Provides binary/memory based functionality."""

# =============================================================================

# >> IMPORTS

# =============================================================================

# Python

import inspect

# Source.Python

# Loggers

from loggers import _sp_logger

# =============================================================================

# >> FORWARD IMPORTS

# =============================================================================

# Source.Python

# core

from core import AutoUnload

# memory

from _memory import BinaryFile

from _memory import CallingConvention

from _memory import CLASS_INFO

from _memory import Convention

from _memory import DataType

from _memory import EXPOSED_CLASSES

from _memory import Function

from _memory import FunctionInfo

from _memory import NULL

from _memory import Pointer

from _memory import ProcessorRegister

from _memory import Register

from _memory import Registers

from _memory import StackData

from _memory import TYPE_SIZES

from _memory import alloc

from _memory import find_binary

from _memory import get_data_type_size

from _memory import get_object_pointer

from _memory import get_size

from _memory import make_object

# =============================================================================

# >> ALL DECLARATION

# =============================================================================

__all__ = ('BinaryFile',

'CLASS_INFO',

'Callback',

'CallingConvention',

'Convention',

'DataType',

'EXPOSED_CLASSES',

'Function',

'FunctionInfo',

'NULL',

'Pointer',

'ProcessorRegister',

'Register',

'Registers',

'StackData',

'TYPE_SIZES',

'alloc',

'find_binary',

'get_class',

'get_class_info',

'get_class_name',

'get_data_type_size',

'get_function_info',

'get_object_pointer',

'get_size',

'get_virtual_function',

'make_object'

)

# =============================================================================

# >> GLOBAL VARIABLES

# =============================================================================

# Get the sp.memory logger

memory_logger = _sp_logger.memory

# =============================================================================

# >> CLASSES

# =============================================================================

class Callback(AutoUnload, Function):

"""Decorator to create a function in memory to call a Python callback."""

def __init__(self, convention, arg_types, return_type):

"""Initialize the Callback object.

:param Convention|CallingConvention convention: Calling convention

that should be used for this callback.

:param iterable arg_types: Argument types of the callback.

:param return_type: Return type of the callback.

"""

self.callback = None

# Allocate enough space for a jump, so we can hook it later. Then

# convert it to a function. Of course, this isn't a function, but the

# hook will override it.

super().__init__(

alloc(8, False).address, convention, arg_types, return_type)

self.add_pre_hook(self._hook)</div>

def _hook(self, args):

"""Call the callback and get the return value."""

return_value = self.callback(args)

if return_value is not None:

return return_value

if self.return_type == DataType.VOID:

return 0

# We will crash now :(

raise ValueError('Return value is not allowed to be None.')

def __call__(self, *args, **kw):

"""Store the given callback on the first call.

All further calls will call the created callback function.

"""

if self.callback is None:

assert callable(args[0])

self.callback = args[0]

return self

return super().__call__(*args, **kw)

def _unload_instance(self):

"""Remove the hook, restore the allocated space and deallocate it."""

self._delete_hook()

self.dealloc()</div>

# =============================================================================

# >> FUNCTIONS

# =============================================================================

def get_virtual_function(obj, function_name, function_index=0):

"""Return a :class:`Function` object.

Create the :class:`Function` object by using

a :class:`FunctionInfo` object.

:param obj: An object of an exposed class.

:param str function_name: See :func:`get_function_info`.

:param int function_index: See :func:`get_function_info`.

:raise ValueError: See :func:`get_class_name`.

"""

return get_object_pointer(obj).make_virtual_function(

get_function_info(obj, function_name, function_index))</div>

def get_function_info(cls, function_name, function_index=0):

"""Return the :class:`FunctionInfo` object of a member function.

:param str cls: See :func:`get_class_info`.

:param str function_name: The name of the member function on the C++ side.

:param int function_index: The index of the member function in the

function info list. This is only required if the function is

overloaded and you want to get a different FunctionInfo object than

the first one.

:raise ValueError: See :func:`get_class_name`.

"""

return get_class_info(cls)[function_name][function_index]</div>

def get_class_info(cls):

"""Return the class info dictionary of a class.

:param str cls: A string that defines the name of the class on the C++

side or an exposed class or an object of an exposed class.

:raise ValueError: See :func:`get_class_name`.

"""

if isinstance(cls, str):

return CLASS_INFO[cls]

if not inspect.isclass(cls):

cls = cls.__class__

return get_class_info(get_class_name(cls))</div>

def get_class_name(cls):

"""Return the name of a class or class object on the C++ side.

:param cls: A class or class object.

:raise ValueError: Raised if the class was not exposed by Source.Python.

"""

cls = cls.__class__

for name, possible_cls in EXPOSED_CLASSES.items():

if cls is possible_cls:

return name

for base_class in cls.__bases__:

try:

class_name = get_class_name(base_class)

except ValueError:

continue

else:

return class_name

raise ValueError('Given class was not exposed.')</div>

def get_class(classname):

"""Return the class of an exposed class by its C++ class name.

:param str classname: The name of the exposed class on the C++ side.

:raise KeyError: Raised if the `classname` is not the name of an exposed

class.

"""

return EXPOSED_CLASSES[classname]</div>

</pre></div>

</div>

</a>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

>index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">memory</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Source.Python/docs/_modules/memory.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

memory.html

Latest commit

History

Breadcrumbs

memory.html

File metadata and controls