Page 2 of 2

Re: Beginners OOP with AHK

Posted: 12 Jan 2018, 14:53
by derz00
so you can bind the reference. Duh... Too bad my brain couldn't stretch that far....

Re: Beginners OOP with AHK

Posted: 12 Jan 2018, 18:53
by nnnik
derz00 wrote:I must read this sometime. Am also in a edX course, learning Python and the science in general. Coming back to AHK it seems really loose, etc. But just the other day I wrote my first class. So I am wondering if you can give any tips? It works well, and does what I want. But it seems like a lot of this. :P Is that just the way it is? Or there would be better ways to design it?

(It is to replace SplashText (gone from v2) in one of my applications.)

Code: Select all

class splash {
	__New() {
		this.v:=GuiCreate("-Caption")
		this.v.SetFont("s16")
		this.v.AddText("r1 x5 w390 center","You have punched " status)
		this.v.SetFont("s18")
		this.st:=this.v.AddText("r1 x5 w390 center",status)
		this.p:=this.v.Add("Progress", "x50 w300 h20 cBlack")
	}
	splash_icon(status, timeout := 1600) {
		global In_Icon, Out_Icon
		TraySetIcon(status?In_Icon:Out_Icon)
		this.st.Text:=status?"IN":"OUT"
		this.st.Opt(status?"cRed":"cBlack")
		this.p.Opt(status?"cRed":"cBlack")
		this.v.Show("w400 h160")
		time:=A_TickCount+timeout
		while A_TickCount < time {
			this.p.Value := ceil(100-(time-A_TickCount)/timeout*100)
			sleep 125
		}
		this.v.Hide()
	}
	__Delete() {
		this.v.Destroy()
		this.v:=""
	}
}
Well you are wrapping around an object so you use a lot of this.v to access that object
I don't quite see why you use a class for this. A class is something that should be general - so why are you using globals instead of a parameter for In_Icon and Out_Icon.
I also feel that your class lacks more methods and that your splash_icon method should actually be the constructor.

Re: Beginners OOP with AHK

Posted: 12 Jan 2018, 19:03
by nnnik
I added quite a bit to the second part - I think I will make a clean cut soon and start a second tutorial which ill cover slightly more advanced topics, that can really make the difference between a good useable class and some attempt at doing something.
The third part is used for a special category I will call "Tips & Tricks and Ticks and Trips" which will summarize some of the things I have said, give additionaly information and suggest projects you can do by yourself or others have created that you can play around with.

Re: Beginners OOP with AHK

Posted: 13 Jan 2018, 08:34
by derz00
Thank you for your input. Is "constructor" the __New() method?

Yes this is not a general class. I mostly created it just to see if I could. Maybe I should expand it and generalize it, to share as a SplashText type of thing.

Re: Beginners OOP with AHK

Posted: 18 Jan 2018, 18:14
by nnnik
Yes the constructor is the __New method.
I also added quite a bit to the second part - I think I'm almost finished with this tutorial.

Re: Beginners OOP with AHK

Posted: 19 Jan 2018, 12:46
by Helgef
Hello I read the second part now, it is very well composed :thumbup:.
I have minor disagreements,
Avoid variable names that sound like they would make good class names
There is no need to think like this, especially not since force [docs]local[/docs] was recently added.
Avoid byref
Inside the called function it is not an issue, the caller can declare the byref variable as local. Byref is very useful, eg when passing big strings.
Put your classes inside another class and name your file after that class
It is good advise :thumbup:

I like that the tutorial led to a real piece of usable code :thumbup:

Cheers.

Re: Beginners OOP with AHK

Posted: 19 Jan 2018, 14:38
by nnnik
Helgef wrote:Hello I read the second part now, it is very well composed :thumbup:.
I have minor disagreements,
Avoid variable names that sound like they would make good class names
There is no need to think like this, especially not since force [docs]local[/docs] was recently added.
Avoid byref
Inside the called function it is not an issue, the caller can declare the byref variable as local. Byref is very useful, eg when passing big strings.
I have to say that I didn't have a look at recent developments regarding AHK in depth - towards me this local mode is news - it looks like good news.
However within this tutorial I present design decision making and coding behaviour that has become a habit to me.
Also I will still stand my word that it is better to avoid byref as an output variable in the context of OOP.
You cannot expect the user of your class to use proper coding in order to avoid the drawbacks of byRef.
You still could use byRef for the speedy input of data into a function or a method - however that speed gain is only possible for very limited cases where a variable is provided directly as the input.
In other cases byRef doesn't provide any advantage. Working with variables that contain strings directly is very rare in my OOP style - I can imagine that it is the same for everyone and the same for OOP in general.
In order to create fast OOP we will probably have to create a speedy String class. Actually testing it out convinced me - if you want fast strings with AHK OOP you will have to use a string class:
https://autohotkey.com/boards/viewtopic ... 72#p195372
It is good advise :thumbup:
I like that the tutorial led to a real piece of usable code :thumbup:
Cheers.
Yeah I like that tip too.
And I ill spend a lot of time on this class, because it is something very basic that I want people to built upon.
I just plan to write this class and take you guys along for the ride.

Re: Beginners OOP with AHK

Posted: 24 Jan 2018, 16:37
by nnnik
I have added a bit to the third part - I thought I would finish this tonight but apparently it was more than I expected.

Re: Beginners OOP with AHK

Posted: 24 Jan 2018, 20:47
by derz00
There, I read part 1. Time to celebrate.

derz00 slaps himself on the back sarcastically

Re: Beginners OOP with AHK

Posted: 25 Jan 2018, 13:44
by nnnik
Thanks for reading it.
Did you have trouble understanding anything?
Were there any parts that confused you?

Re: Beginners OOP with AHK

Posted: 25 Jan 2018, 15:59
by Xtra
@nnnik: Thanks for taking the time to do this tutorial, well done.

Re: Beginners OOP with AHK

Posted: 26 Jan 2018, 09:11
by derz00
nnnik wrote:Thanks for reading it.
Did you have trouble understanding anything?
Were there any parts that confused you?
No, it all made sense to me. The concept of the this. reference is not new to me, so I can't really give feedback on your explanation. But it is one of the confusing parts of the syntax. Just because it's difficult to put it into words, I guess.

If I hadn't been watching this thread and seen you were actively working on it, I probably wouldn't have read it. The first part laid things out well, now I want to get into the next parts as I have time, to learn the skills of it.

Re: Beginners OOP with AHK

Posted: 27 Jan 2018, 18:55
by nnnik
I have finished adding the last part.
In the next few days I might go over this tutorial and correct a few mistakes or add things I forgot - but not many things will change.

Re: Beginners OOP with AHK

Posted: 06 Feb 2018, 11:07
by nnnik
I added local to the modularity tips and added 2 more Tricks to the last section.
I also fixed many of the sentences in the first part. You should be able to read it more easily now.