[Plugin] Library - Call DLL functions directily from Teir 1

Author

Message

PartTimeCoder

AGK Tool Maker

9

Years of Service

User Offline

Joined: 9th Mar 2015

Location: London UK

Posted: 24th Jun 2017 06:21 Edited at: 24th Jun 2017 10:00

Link

Not sure how useful this would be I just fancied the challenge of making it work

This plugin will enable you to call functions in dynamic link library's directly from Tier 1 code (windows only) without needing them formatted as a plugin, it currently only supports functions with up to 5 arguments but I can expand this to support upto 20 arguments, it also only supports string and integer argument types and integer returns, this is a limitation of PureBasic but I think I can code a work-a-round, I might be able to support string returns depends on the demand but for now I'm pretty happy it works as there's many library's out there that could be useful even with the limitations.

Edit: Now supports 20 max arguments and string returns via memory buffer
Added functions:
Library.Alloc()
Library.DeAlloc()
Library.Peek()

Example using GetClassNameA

+ Code Snippet

if Library.Open(1,"User32.dll")

	FindWindow = Library.GetFunction(1, "FindWindowA")
	Library.PutIntParam(0)
	Library.PutStringParam("Library")
	HWND=Library.CallFunction(FindWindow)
	Library.ClearParams()
	
	Buffer=Library.Alloc(255)
	
	GetClassName = Library.GetFunction(1, "GetClassNameA")
	Library.PutIntParam(HWND)
	Library.PutIntParam(Buffer)
	Library.PutIntParam(255)
	Library.CallFunction(GetClassName)
	Library.ClearParams()
	
	classname$=Library.Peek(Buffer)
	Library.DeAlloc(Buffer)
	
	Library.Close(1)

endif

do
	print(classname$)

    Sync()
loop

heres a few basic usage examples
// show a message box
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms645505(v=vs.85).aspx

+ Code Snippet

if Library.Open(1,"User32.dll")
 
	FindWindow = Library.GetFunction(1, "FindWindowA")
	Library.PutIntParam(0)
	Library.PutStringParam("Library")
	HWND=Library.CallFunction(FindWindow)
	Library.ClearParams()
	
	MessageBox = Library.GetFunction(1, "MessageBoxA")
	Library.PutIntParam(HWND)
	Library.PutStringParam("Message")
	Library.PutStringParam("Title")
	Library.PutIntParam(306)
	Library.CallFunction(MessageBox)
	Library.ClearParams()
	
	Library.Close(1)
endif

// play a beep sound
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms679277(v=vs.85).aspx

+ Code Snippet

if Library.Open(1,"Kernel32.dll")

	Beep = Library.GetFunction(1, "Beep")
	
	Library.PutIntParam(750)
	Library.PutIntParam(1000)
	Library.CallFunction(Beep)
	Library.ClearParams()
	
	Library.PutIntParam(1750)
	Library.PutIntParam(1000)
	Library.CallFunction(Beep)
	Library.ClearParams()
	
	Library.Close(1)
endif

// play a message beep
// https://msdn.microsoft.com/en-us/library/windows/desktop/ms680356(v=vs.85).aspx

+ Code Snippet

if Library.Open(1,"User32.dll")
	
	MessageBeep = Library.GetFunction(1, "MessageBeep")
	Library.PutIntParam(16)
	Library.CallFunction(MessageBeep)
	Library.ClearParams()
	
	Library.Close(1)
endif

// show shell about dialog
// https://msdn.microsoft.com/en-us/library/windows/desktop/bb762152(v=vs.85).aspx

+ Code Snippet

if Library.Open(1,"User32.dll")
	if Library.Open(2,"Shell32.dll")
	
		FindWindow = Library.GetFunction(1, "FindWindowA")
		Library.PutIntParam(0)
		Library.PutStringParam("Library")
		HWND=Library.CallFunction(FindWindow)
		Library.ClearParams()
		
		ShellAbout = Library.GetFunction(2, "ShellAboutA")
		Library.PutIntParam(HWND)
		Library.PutStringParam("My App Name")
		Library.PutStringParam("My App Info")
		Library.PutIntParam(0)	
		Library.CallFunction(ShellAbout)
		Library.ClearParams()
		
		Library.Close(1)
		Library.Close(2)
		
	endif
endif

if anyone finds it useful let me know and I'll expand the function set, I don't own any DBPro dll's but I'm curious to know if this system will help support them, anyone want to colab?, are they even compatible?

Tier 1 Includes
Timer Include HashTable Include INI Include HealthBar Include

Tier 1 Plugins
Library Plugin TTS Plugin Clipboard Plugin Debug Plugin

Attachments

Login to view attachments

Back to top

Profile PM

PartTimeCoder

AGK Tool Maker

9

Years of Service

User Offline

Joined: 9th Mar 2015

Location: London UK

Posted: 24th Jun 2017 08:06 Edited at: 24th Jun 2017 08:57

Link

Heres a full MessageBox example showing how to use API flags with icons and return values

#import_plugin Library

#Constant MB_ABORTRETRYIGNORE 2
#Constant MB_OK 0
#Constant MB_OKCANCEL 1
#Constant MB_RETRYCANCEL 5
#Constant MB_YESNO 4
#Constant MB_YESNOCANCEL 3

#Constant MB_ICONEXCLAMATION 48
#Constant MB_ICONWARNING 48
#Constant MB_ICONINFORMATION 64
#Constant MB_ICONASTERISK 64
#Constant MB_ICONQUESTION 32
#Constant MB_ICONSTOP 16
#Constant MB_ICONERROR 16
#Constant MB_ICONHAND 16

#Constant MB_DEFBUTTON1 0
#Constant MB_DEFBUTTON2 256
#Constant MB_DEFBUTTON3 512

#Constant IDABORT 3
#Constant IDCANCEL 2
#Constant IDIGNORE 5
#Constant IDNO 7
#Constant IDOK 1
#Constant IDRETRY 4
#Constant IDYES 6

Function MessageBox(Parent as string, Title as string, Text as string, MsgType, Icon, DefButton)
	if Library.Open(1,"User32.dll")
	 
		FindWindow = Library.GetFunction(1, "FindWindowA")
		Library.PutIntParam(0)
		Library.PutStringParam(Parent)
		HWND=Library.CallFunction(FindWindow)
		Library.ClearParams()
		
		MessageBox = Library.GetFunction(1, "MessageBoxA")
		Library.PutIntParam(HWND)
		Library.PutStringParam(Text)
		Library.PutStringParam(Title)
		Library.PutIntParam(MsgType+DefButton+Icon)
		Result=Library.CallFunction(MessageBox)
		Library.ClearParams()
		
		Library.Close(1)
	endif
EndFunction Result

Select MessageBox("Library", "Title", "Click a button", MB_OKCANCEL, MB_ICONERROR, MB_DEFBUTTON1)
	Case IDOK
		MessageBox("Library", "Title", "You clicked OK", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
	Case IDCANCEL
		MessageBox("Library", "Title", "You clicked Cancel", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
EndSelect

Select MessageBox("Library", "Title", "Click a button", MB_ABORTRETRYIGNORE, MB_ICONEXCLAMATION, MB_DEFBUTTON2)
	Case IDABORT
		MessageBox("Library", "Title", "You clicked Abort", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
	Case IDRETRY
		MessageBox("Library", "Title", "You clicked Retry", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
	Case IDIGNORE
		MessageBox("Library", "Title", "You clicked Ignore", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase	
EndSelect

+ Code Snippet

#import_plugin Library

#Constant MB_ABORTRETRYIGNORE 2
#Constant MB_OK 0
#Constant MB_OKCANCEL 1
#Constant MB_RETRYCANCEL 5
#Constant MB_YESNO 4
#Constant MB_YESNOCANCEL 3

#Constant MB_ICONEXCLAMATION 48
#Constant MB_ICONWARNING 48
#Constant MB_ICONINFORMATION 64
#Constant MB_ICONASTERISK 64
#Constant MB_ICONQUESTION 32
#Constant MB_ICONSTOP 16
#Constant MB_ICONERROR 16
#Constant MB_ICONHAND 16

#Constant MB_DEFBUTTON1 0
#Constant MB_DEFBUTTON2 256
#Constant MB_DEFBUTTON3 512

#Constant IDABORT 3
#Constant IDCANCEL 2
#Constant IDIGNORE 5
#Constant IDNO 7
#Constant IDOK 1
#Constant IDRETRY 4
#Constant IDYES 6

Function MessageBox(Parent as string, Title as string, Text as string, MsgType, Icon, DefButton)
	if Library.Open(1,"User32.dll")
	 
		FindWindow = Library.GetFunction(1, "FindWindowA")
		Library.PutIntParam(0)
		Library.PutStringParam(Parent)
		HWND=Library.CallFunction(FindWindow)
		Library.ClearParams()
		
		MessageBox = Library.GetFunction(1, "MessageBoxA")
		Library.PutIntParam(HWND)
		Library.PutStringParam(Text)
		Library.PutStringParam(Title)
		Library.PutIntParam(MsgType+DefButton+Icon)
		Result=Library.CallFunction(MessageBox)
		Library.ClearParams()
		
		Library.Close(1)
	endif
EndFunction Result

Select MessageBox("Library", "Title", "Click a button", MB_OKCANCEL, MB_ICONERROR, MB_DEFBUTTON1)
	Case IDOK
		MessageBox("Library", "Title", "You clicked OK", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
	Case IDCANCEL
		MessageBox("Library", "Title", "You clicked Cancel", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
EndSelect

Select MessageBox("Library", "Title", "Click a button", MB_ABORTRETRYIGNORE, MB_ICONEXCLAMATION, MB_DEFBUTTON2)
	Case IDABORT
		MessageBox("Library", "Title", "You clicked Abort", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
	Case IDRETRY
		MessageBox("Library", "Title", "You clicked Retry", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase
	Case IDIGNORE
		MessageBox("Library", "Title", "You clicked Ignore", MB_OK, MB_ICONINFORMATION, MB_DEFBUTTON1)
	EndCase	
EndSelect

Back to top

Profile PM

Rich Dersheimer

AGK Developer

15

Years of Service

User Offline

Joined: 1st Jul 2009

Location: Inside the box

Posted: 9th Aug 2017 18:06

Link

Hi PartTimeCoder! Would your library plugin be able to call the color picker in windows? If so, would you pretty please post a snippet doing this? I'm not quite clever enough to figure out if or how to do this.

Back to top

Profile PM Email

PartTimeCoder

AGK Tool Maker

9

Years of Service

User Offline

Joined: 9th Mar 2015

Location: London UK

Posted: 9th Aug 2017 19:37

Link

the ChooseColor() function expects a pointer to a CHOOSECOLOR structure and fills the structure based on the users selection and this is used inplace of a return value, altho it is possible to this by assigning the memory I don't really know how to do it this way, this library plugin was a "see if it could be done" project and although it works its a little restrictive, it has no direct access to structure data

As luck would have it I have a plugin I am using where I have used ChooseColor() but added in proper custom color selection, you know when you set a custom color, open the dialog again and the colors are all reset, well my implementation saves the color set to ini file ready for use next time round even after the application has been restarted.

the code is very heavily embedded in a private plugin I am using for a project but give me an hour or 2 and I'll export the code to a separate plugin.

Back to top

Profile PM

PartTimeCoder

AGK Tool Maker

9

Years of Service

User Offline

Joined: 9th Mar 2015

Location: London UK

Posted: 9th Aug 2017 20:47

Link

I thought rather than just have a single function plugin that I would add some more dialog types to this

#Import_Plugin Dialog

// Dialog.Message message type constants
#Constant MB_OK 0
#Constant MB_OKCANCEL 1
#Constant MB_ABORTRETRYIGNORE 2
#Constant MB_YESNOCANCEL 3
#Constant MB_YESNO 4
#Constant MB_RETRYCANCEL 5
// Dialog.Message icon constants
#Constant MB_ICONWARNING 48
#Constant MB_ICONINFORMATION 64
#Constant MB_ICONQUESTION 32
#Constant MB_ICONERROR 16
// Dialog.Message default button constants
#Constant MB_DEFBUTTON1 0
#Constant MB_DEFBUTTON2 256
#Constant MB_DEFBUTTON3 512
// Dialog.Message return constants
#Constant IDABORT 3
#Constant IDCANCEL 2
#Constant IDIGNORE 5
#Constant IDNO 7
#Constant IDOK 1
#Constant IDRETRY 4
#Constant IDYES 6

// CALL THIS FIRST
// this lets the plugin get the agk 
// window handle for modal dialogs
Dialog.SetAGK("Dialog Plugin")

// returns the selected color or -1 if canceled
// will auto save custom color pallet to temp folder ("AGKCustomColors.ini")
// Dialog.Color(default color)
SelColor=Dialog.Color(255)

// Dialog.OpenFile(title, default file, file pattern, pattern index)
OpenFile$=Dialog.OpenFile("Select File to open", "", "Text (*.txt)|*.txt|All files (*.*)|*.*", 0)

// Dialog.SaveFile(title, default file, file pattern, pattern index)
SaveFile$=Dialog.SaveFile("Select File to save", "", "Text (*.txt)|*.txt|All files (*.*)|*.*", 0)

// Dialog.Path(title, default path)
Path$=Dialog.Path("Select path", "")

//Dialog.Message(title, message, message type, icon, def button)
Dialog.Message("AGK Message", "This is a ok dialog", MB_OK, 0 ,0)  // 
Dialog.Message("AGK Message", "This is a ok/cancel dialog", MB_OKCANCEL, 0 ,0)
Dialog.Message("AGK Message", "This is a yes/no dialog", MB_YESNO, MB_ICONQUESTION ,0)
Dialog.Message("AGK Message", "This is a yes/no/cancel dialog", MB_YESNOCANCEL, MB_ICONQUESTION ,MB_DEFBUTTON2)
Dialog.Message("AGK Message", "This is a retry/cancel dialog", MB_RETRYCANCEL, MB_ICONERROR ,MB_DEFBUTTON2)
Dialog.Message("AGK Message", "You get the 'Message' right?", MB_OK, MB_ICONQUESTION ,0)

do
    Print(SelColor)
	Print(OpenFile$)
	Print(SaveFile$)
    Print(Path$)
    Sync()
loop

+ Code Snippet

#Import_Plugin Dialog

// Dialog.Message message type constants
#Constant MB_OK 0
#Constant MB_OKCANCEL 1
#Constant MB_ABORTRETRYIGNORE 2
#Constant MB_YESNOCANCEL 3
#Constant MB_YESNO 4
#Constant MB_RETRYCANCEL 5
// Dialog.Message icon constants
#Constant MB_ICONWARNING 48
#Constant MB_ICONINFORMATION 64
#Constant MB_ICONQUESTION 32
#Constant MB_ICONERROR 16
// Dialog.Message default button constants
#Constant MB_DEFBUTTON1 0
#Constant MB_DEFBUTTON2 256
#Constant MB_DEFBUTTON3 512
// Dialog.Message return constants
#Constant IDABORT 3
#Constant IDCANCEL 2
#Constant IDIGNORE 5
#Constant IDNO 7
#Constant IDOK 1
#Constant IDRETRY 4
#Constant IDYES 6

// CALL THIS FIRST
// this lets the plugin get the agk 
// window handle for modal dialogs
Dialog.SetAGK("Dialog Plugin")

// returns the selected color or -1 if canceled
// will auto save custom color pallet to temp folder ("AGKCustomColors.ini")
// Dialog.Color(default color)
SelColor=Dialog.Color(255)

// Dialog.OpenFile(title, default file, file pattern, pattern index)
OpenFile$=Dialog.OpenFile("Select File to open", "", "Text (*.txt)|*.txt|All files (*.*)|*.*", 0)

// Dialog.SaveFile(title, default file, file pattern, pattern index)
SaveFile$=Dialog.SaveFile("Select File to save", "", "Text (*.txt)|*.txt|All files (*.*)|*.*", 0)

// Dialog.Path(title, default path)
Path$=Dialog.Path("Select path", "")


//Dialog.Message(title, message, message type, icon, def button)
Dialog.Message("AGK Message", "This is a ok dialog", MB_OK, 0 ,0)  // 
Dialog.Message("AGK Message", "This is a ok/cancel dialog", MB_OKCANCEL, 0 ,0)
Dialog.Message("AGK Message", "This is a yes/no dialog", MB_YESNO, MB_ICONQUESTION ,0)
Dialog.Message("AGK Message", "This is a yes/no/cancel dialog", MB_YESNOCANCEL, MB_ICONQUESTION ,MB_DEFBUTTON2)
Dialog.Message("AGK Message", "This is a retry/cancel dialog", MB_RETRYCANCEL, MB_ICONERROR ,MB_DEFBUTTON2)
Dialog.Message("AGK Message", "You get the 'Message' right?", MB_OK, MB_ICONQUESTION ,0)


do
    Print(SelColor)
	Print(OpenFile$)
	Print(SaveFile$)
    Print(Path$)
    Sync()
loop

Attachments

Login to view attachments

Back to top

Profile PM

Rich Dersheimer

AGK Developer

15

Years of Service

User Offline

Joined: 1st Jul 2009

Location: Inside the box

Posted: 9th Aug 2017 23:27 Edited at: 9th Aug 2017 23:30

Link

Wow, those will be REALLY useful!

One thing, when I run the code snippet, I get an error "AppGameKit window not registered!"

Any advice?

EDIT: Never mind, I didn't have the window named correctly. Thanks so much for your efforts and willingness to share!

Rich

Back to top

Profile PM Email

Blendman

10

Years of Service

User Offline

Joined: 17th Feb 2014

Location: Arkeos

Posted: 25th Aug 2017 10:05

Link

Hi

It's very interesting.

I have tried the dialog, and it doesn't work properly.

it's ok for :

+ Code Snippet

Dialog.SetAGK("Dialog Plugin") 
SelColor = Dialog.Color(255)
 OpenFile$ = Dialog.OpenFile("Select File to open", "", "Text (*.txt)|*.txt|All files (*.*)|*.*", 0)
 SaveFile$ = Dialog.SaveFile("Select File to save", "", "Text (*.txt)|*.txt|All files (*.*)|*.*", 0)

But for :

+ Code Snippet

Path$ = Dialog.Path("Select path", "")

The application doesn't respond and crash.
it seems:

+ Code Snippet

Dialog.Path("Select path", "")

doesn't work properly.
When I comment this line, it's ok.

Do you know if we can add some gadgets and menu in agk ?
it would be awesome

AGK2 tier1 - http://www.dracaena-studio.com

Back to top

Profile PM Website

PartTimeCoder

AGK Tool Maker

9

Years of Service

User Offline

Joined: 9th Mar 2015

Location: London UK

Posted: 25th Aug 2017 13:04

Link

Funny thing I tested it before posting and it worked fine but yes its crashing here too, I'll open it up and take a look a bit later.

Quote: "Do you know if we can add some gadgets and menu in agk ?"

not directly, AppGameKit wants to draw over the top of them, you can however build a UI in PB and embed AppGameKit into it

first you create a plugin function that sends in the title of the agk window, in your UI have a container host for agk, and use the below code to embed it.

(this is pulled directly from my 3D editor)

agk_hWnd=FindWindow_(#Null, title)
  If IsWindow_(agk_hWnd)

; set the window icon from the agk window
    agk_icon=GetClassLongPtr_(agk_hWnd, #GCL_HICON)
    SendMessage_(WindowID(#Window_Editor), #WM_SETICON, 0, agk_icon)
    
    ; tell the container to accept child objects
    SetWindowLong_(GadgetID(#Container_AGK), #GWL_STYLE, GetWindowLong_(GadgetID(#Container_AGK), #GWL_STYLE) | #WS_CLIPCHILDREN)
    
    ; remove agk window styles and set it as child
    lStyle = GetWindowLong_(agk_hWnd, #GWL_STYLE)
    lStyle&~(#WS_CAPTION | #WS_THICKFRAME | #WS_MINIMIZE | #WS_MAXIMIZE | #WS_SYSMENU | #WS_POPUP)
    SetWindowLong_(agk_hWnd, #GWL_STYLE, lStyle | #WS_CHILD) 
    
    ; remove agk window extended styles
    lExStyle = GetWindowLong_(agk_hWnd, #GWL_EXSTYLE)
    lExStyle&~(#WS_EX_DLGMODALFRAME | #WS_EX_CLIENTEDGE | #WS_EX_STATICEDGE)
    SetWindowLong_(agk_hWnd, #GWL_EXSTYLE, lExStyle)
        
    ;; now set the container as agk's parent
    SetParent_(agk_hWnd, GadgetID(#Container_AGK))
    ShowWindow_(agk_hWnd, #SW_SHOW)
  EndIf

+ Code Snippet

  agk_hWnd=FindWindow_(#Null, title)
  If IsWindow_(agk_hWnd)

    ; set the window icon from the agk window
    agk_icon=GetClassLongPtr_(agk_hWnd, #GCL_HICON)
    SendMessage_(WindowID(#Window_Editor), #WM_SETICON, 0, agk_icon)
    
    ; tell the container to accept child objects
    SetWindowLong_(GadgetID(#Container_AGK), #GWL_STYLE, GetWindowLong_(GadgetID(#Container_AGK), #GWL_STYLE) | #WS_CLIPCHILDREN)
    
    ; remove agk window styles and set it as child
    lStyle = GetWindowLong_(agk_hWnd, #GWL_STYLE)
    lStyle&~(#WS_CAPTION | #WS_THICKFRAME | #WS_MINIMIZE | #WS_MAXIMIZE | #WS_SYSMENU | #WS_POPUP)
    SetWindowLong_(agk_hWnd, #GWL_STYLE, lStyle | #WS_CHILD) 
    
    ; remove agk window extended styles
    lExStyle = GetWindowLong_(agk_hWnd, #GWL_EXSTYLE)
    lExStyle&~(#WS_EX_DLGMODALFRAME | #WS_EX_CLIENTEDGE | #WS_EX_STATICEDGE)
    SetWindowLong_(agk_hWnd, #GWL_EXSTYLE, lExStyle)
        
    ;; now set the container as agk's parent
    SetParent_(agk_hWnd, GadgetID(#Container_AGK))
    ShowWindow_(agk_hWnd, #SW_SHOW)
  EndIf

AGK now becomes part of your UI, use the plugin system to send events and create functions to add/remove gadget items, be warned, do not try and make AppGameKit handle complete UI creation by wrapping PB's functions, A. its against the PB EULA and B. it will crash, PB is fast, use that to your advantage and do as much work in the PB side as you can this will make it 100% more stable and keep your FPS nice n high

for example, use a SendMessage type system, so a single plugin function can have multiple uses and the heavy lifting of a huge select statement is done in PB and AppGameKit in not loading 100's of plugin functions on startup, you just need agk to 'ask' the UI what event just happened..... a lot of trial n error got me this far and my system seems pretty stable now I ironed out the bugs.

I'll get that plugin looked at soon, dont like bugs! lol

Back to top

Profile PM

Sorry your browser is not supported!

AppGameKit Classic Chat / [Plugin] Library - Call DLL functions directily from Teir 1

Attachments

Attachments