Beginners OOP with AHK

Post a reply

Confirmation code
Enter the code exactly as it appears. All letters are case insensitive.
Smilies
:D :) ;) :( :o :shock: :? 8-) :lol: :x :P :oops: :cry: :evil: :twisted: :roll: :!: :?: :idea: :| :mrgreen: :geek: :ugeek: :arrow: :angel: :clap: :crazy: :eh: :lolno: :problem: :shh: :shifty: :sick: :silent: :think: :thumbup: :thumbdown: :salute: :wave: :wtf: :yawn: :facepalm: :bravo: :dance: :beard: :morebeard: :xmas: :HeHe: :trollface: :cookie: :rainbow: :monkeysee: :monkeysay: :happybday: :headwall: :offtopic: :superhappy: :terms: :beer:
View more smilies

BBCode is ON
[img] is OFF
[flash] is OFF
[url] is ON
Smilies are ON

Topic review
   

Expand view Topic review: Beginners OOP with AHK

Re: Beginners OOP with AHK

Post by nnnik » 06 Feb 2018, 11:07

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.

Re: Beginners OOP with AHK

Post by nnnik » 27 Jan 2018, 18:55

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

Post by derz00 » 26 Jan 2018, 09:11

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

Post by Xtra » 25 Jan 2018, 15:59

@nnnik: Thanks for taking the time to do this tutorial, well done.

Re: Beginners OOP with AHK

Post by nnnik » 25 Jan 2018, 13:44

Thanks for reading it.
Did you have trouble understanding anything?
Were there any parts that confused you?

Re: Beginners OOP with AHK

Post by derz00 » 24 Jan 2018, 20:47

There, I read part 1. Time to celebrate.

derz00 slaps himself on the back sarcastically

Re: Beginners OOP with AHK

Post by nnnik » 24 Jan 2018, 16:37

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

Post by nnnik » 19 Jan 2018, 14:38

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 local 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

Post by Helgef » 19 Jan 2018, 12:46

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 local 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

Post by nnnik » 18 Jan 2018, 18:14

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

Post by derz00 » 13 Jan 2018, 08:34

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

Post by nnnik » 12 Jan 2018, 19:03

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

Post by nnnik » 12 Jan 2018, 18:53

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] [Expand]GeSHi © Codebox Plus

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

Post by derz00 » 12 Jan 2018, 14:53

so you can bind the reference. Duh... Too bad my brain couldn't stretch that far....

Re: Beginners OOP with AHK

Post by stealzy » 12 Jan 2018, 14:50

Code: [Select all]GeSHi © Codebox Plus

this.v:=GuiCreate("-Caption")
g:=this.v
g.SetFont("s16")

Remember only limitation — you can't change this.v by assigning new object to g.

Re: Beginners OOP with AHK

Post by derz00 » 12 Jan 2018, 12:41

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] [Expand]GeSHi © Codebox Plus

Re: Beginners OOP with AHK

Post by wolf_II » 11 Jan 2018, 10:46

Great tutorial, thank you very much!

Re: Beginners OOP with AHK

Post by nnnik » 09 Jan 2018, 16:52

Thanks for the comments Helgef - I will add them at a later date.
I have added another part of the tutorial - and I will leave you with a cliffhanger this time I guess.

Re: Beginners OOP with AHK

Post by Helgef » 07 Jan 2018, 06:50

Hello again :wave:.
It is a good read, well done :thumbup: . I like that you encourage planning, eg, with paper and pen, it really is helpful. I will add a little planning tips: Start by writing the documentation. This is not easy to do when one works on a project alone, because most often one is to eager to start coding, but for shared projects, it is key, imo. Another approach (sort of a digital version of the paper and pen suggestion or a good way to start after you have your plan on paper) is to write an empty class, that is a class which only contains methods and properties but no actual implementation. For the file example, one could begin to write this, and add comments about input/output/algorithms etc,...

Code: [Select all] [Expand]GeSHi © Codebox Plus


This gives a good overview and is a good base for the documentation. You keep the sketch and then implement a copy of it, updateing the sketch if needed, when done with the implementation, much of the documentation is done too.


__init() is not even documented

It is mentioned under instance variables.
The method name __Init is reserved for this purpose, and should not be used by the script.


Thanks for your efforts.
Cheers.

Re: Beginners OOP with AHK

Post by nnnik » 05 Jan 2018, 12:19

Thanks Corrected

Top