mirror of
https://github.com/moparisthebest/Simba
synced 2024-11-30 21:02:16 -05:00
First code documentation using LazDoc.
It also added the os_linux unit to Simba.lpr, I guess it needs to do this for the FPDoc to work properly.
This commit is contained in:
parent
3d485deba3
commit
853b5227d0
86
LazDoc/os_linux.xml
Normal file
86
LazDoc/os_linux.xml
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<fpdoc-descriptions>
|
||||||
|
<package name="Simba">
|
||||||
|
<module name="os_linux">
|
||||||
|
<element name="TWindow.GetTargetDimensions">
|
||||||
|
<descr>Returns the dimension of the TWindow</descr>
|
||||||
|
<short>Uses XGetWindowAttributes to retrieve the dimensions of the stored TWindow.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.HoldKey">
|
||||||
|
<short>Uses TKeyInput class from lazarus to fake a keydown event.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.ReleaseKey">
|
||||||
|
<short>Uses TKeyInput class from lazarus to fake a keyup event.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.IsKeyHeld">
|
||||||
|
<short>Should return true if the given key is held down. NOT YET IMPLEMENTED ON LINUX</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.TargetValid">
|
||||||
|
<short>Uses XGetWindowAttributes to check if the currently selected window is valid. If we have not recieved an error, the window is valid.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.ActivateClient">
|
||||||
|
<short>Selects the current client as input focus for the X11 windowing system</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.ReturnData">
|
||||||
|
<short>Uses XGetImage to get the pixel data of the currently stored TWindow. The image data is passed as result.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.FreeReturnData">
|
||||||
|
<short>Frees the XImage object called buffer if it is set. This should be called once the ReturnData result is no longer required.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.GetMousePosition">
|
||||||
|
<short>Uses XQueryPointer to query the current mouse position relative to the stored TWindow.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.MoveMouse">
|
||||||
|
<short>Uses XWarpPointer to move the mouse to the specific position relative to the stored TWindow.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.HoldMouse">
|
||||||
|
<short>Uses XTest to fake a mouse button press.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.ReleaseMouse">
|
||||||
|
<short>Uses XTest to fake a mouse button release.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.IsMouseButtonHeld">
|
||||||
|
<short>Uses XQueryPointer to return if the given mouse button is held.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TIOManager">
|
||||||
|
<short>Linux/X11 implementation of the TIOManager</short>
|
||||||
|
</element>
|
||||||
|
<element name="TIOManager.SetTarget">
|
||||||
|
<short>Set the stored TWindow to the passed TNativeWindow.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TIOManager.SetDesktop">
|
||||||
|
<short>Set the desktop as stored TWindow.</short>
|
||||||
|
</element>
|
||||||
|
<element name="TIOManager.NativeInit">
|
||||||
|
<short>Open the X11 connection</short>
|
||||||
|
</element>
|
||||||
|
<element name="TIOManager.NativeFree">
|
||||||
|
<short>Close the X11 connection.</short>
|
||||||
|
</element>
|
||||||
|
<element name="MufasaXErrorHandler">
|
||||||
|
<short>X Error Handler.</short>
|
||||||
|
<descr> This is extremely hacky, but also very useful.
|
||||||
|
We have to install a X error handler, because otherwise X
|
||||||
|
will terminate out entire app on error.
|
||||||
|
|
||||||
|
Since we want the right thread to recieve the right error, we have to
|
||||||
|
fiddle a bit with threadvars, mutexes / semaphores.
|
||||||
|
|
||||||
|
Another problem is that the script thread is initialised on the main thread.
|
||||||
|
This means that all (threadvar!) semaphores initialised on the mainthread
|
||||||
|
are NOT initialised on the script thread, which has yet to be started.
|
||||||
|
Therefore, we check if it hasn't been created yet.
|
||||||
|
|
||||||
|
** Horrible solution, but WFM **
|
||||||
|
|
||||||
|
This is the Handler function. </descr>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.ReceivedError">
|
||||||
|
<short>Returns true if we have received an error</short>
|
||||||
|
</element>
|
||||||
|
<element name="TWindow.GetNativeWindow">
|
||||||
|
<short>Returns the stored TWindow</short>
|
||||||
|
</element>
|
||||||
|
</module>
|
||||||
|
</package>
|
||||||
|
</fpdoc-descriptions>
|
@ -12,6 +12,7 @@
|
|||||||
<UseXPManifest Value="True"/>
|
<UseXPManifest Value="True"/>
|
||||||
<Icon Value="0"/>
|
<Icon Value="0"/>
|
||||||
</General>
|
</General>
|
||||||
|
<LazDoc Paths="../../LazDoc"/>
|
||||||
<VersionInfo>
|
<VersionInfo>
|
||||||
<Language Value="0419"/>
|
<Language Value="0419"/>
|
||||||
<CharSet Value="04B0"/>
|
<CharSet Value="04B0"/>
|
||||||
@ -38,7 +39,7 @@
|
|||||||
<PackageName Value="LCL"/>
|
<PackageName Value="LCL"/>
|
||||||
</Item2>
|
</Item2>
|
||||||
</RequiredPackages>
|
</RequiredPackages>
|
||||||
<Units Count="47">
|
<Units Count="48">
|
||||||
<Unit0>
|
<Unit0>
|
||||||
<Filename Value="Simba.lpr"/>
|
<Filename Value="Simba.lpr"/>
|
||||||
<IsPartOfProject Value="True"/>
|
<IsPartOfProject Value="True"/>
|
||||||
@ -203,7 +204,7 @@
|
|||||||
<IsPartOfProject Value="True"/>
|
<IsPartOfProject Value="True"/>
|
||||||
<ComponentName Value="SettingsForm"/>
|
<ComponentName Value="SettingsForm"/>
|
||||||
<ResourceBaseClass Value="Form"/>
|
<ResourceBaseClass Value="Form"/>
|
||||||
<UnitName Value="SimbaSettings"/>
|
<UnitName Value="Simbasettings"/>
|
||||||
</Unit29>
|
</Unit29>
|
||||||
<Unit30>
|
<Unit30>
|
||||||
<Filename Value="../../Units/MMLAddon/PSInc/Wrappers/tpa.inc"/>
|
<Filename Value="../../Units/MMLAddon/PSInc/Wrappers/tpa.inc"/>
|
||||||
@ -293,6 +294,11 @@
|
|||||||
<ResourceBaseClass Value="Form"/>
|
<ResourceBaseClass Value="Form"/>
|
||||||
<UnitName Value="bitmapconv"/>
|
<UnitName Value="bitmapconv"/>
|
||||||
</Unit46>
|
</Unit46>
|
||||||
|
<Unit47>
|
||||||
|
<Filename Value="../../Units/MMLCore/os_linux.pas"/>
|
||||||
|
<IsPartOfProject Value="True"/>
|
||||||
|
<UnitName Value="os_linux"/>
|
||||||
|
</Unit47>
|
||||||
</Units>
|
</Units>
|
||||||
</ProjectOptions>
|
</ProjectOptions>
|
||||||
<CompilerOptions>
|
<CompilerOptions>
|
||||||
|
@ -33,7 +33,7 @@ uses
|
|||||||
{$ENDIF}{$ENDIF}
|
{$ENDIF}{$ENDIF}
|
||||||
Interfaces, Forms, SimbaUnit, colourhistory, About, internets, debugimage,
|
Interfaces, Forms, SimbaUnit, colourhistory, About, internets, debugimage,
|
||||||
framefunctionlist, simpleanalyzer, updater, updateform, Simbasettings,
|
framefunctionlist, simpleanalyzer, updater, updateform, Simbasettings,
|
||||||
libloader, mufasabase, v_ideCodeInsight, PSDump, v_ideCodeParser,
|
libloader, mufasabase, os_linux, v_ideCodeInsight, PSDump, v_ideCodeParser,
|
||||||
v_AutoCompleteForm, CastaliaPasLex, CastaliaPasLexTypes, CastaliaSimplePasPar,
|
v_AutoCompleteForm, CastaliaPasLex, CastaliaPasLexTypes, CastaliaSimplePasPar,
|
||||||
CastaliaSimplePasParTypes, dcpbase64, mPasLex, v_Constants, v_MiscFunctions,
|
CastaliaSimplePasParTypes, dcpbase64, mPasLex, v_Constants, v_MiscFunctions,
|
||||||
extensionmanagergui, mmisc, bitmapconv;
|
extensionmanagergui, mmisc, bitmapconv;
|
||||||
|
Loading…
Reference in New Issue
Block a user