Improve script structure

htcfreek commented 3 years ago

Move general code for better structure

[x] Move FileInstall into _ResourceHelper.au3
[x] Create _OtherHelpers.au3 for various small functions
- [x] Move _INIUnicode($sINI)
- [x] Move _Translate($iMUI, $sString)
- [x] Move all other small functions like the one before.
[ ] Move command line processing into _CommandLineHelper.au3
[x] Combine related functions (example: HighContrast + LightTheme => GetColorTheme)

Checks

[x] Create a function for every check and place it in _Checks.au3
- [x] Use this functions for GUI and command line

Gui code

[x] #699
- [ ] Move all Gui related functions including GDI+ function (_GDIPlus_GraphicsGetDPIRatio)
[x] Add new function _UpdateScanResult($iScanResultIndex, $iState, $sResultText, $sResultInfo) => $iState = Question, Warning, Okay, Error

Comments and structure

[ ] Add a comment to each function like this:

; Description: Function does ...
; Input: param1 = ...; param2 = ...
; Output: ....
; On error: ....

[ ] Structure code by adding comment structure (Not only this region thing, which isn't supported by every editor.):
```
; ========= Init global vars ====
(...)
```

; ======== Includes ======== ; AutoIT-UDFs (...)

; Internal Includes (...)

; ========= Init Gui ========= (...)

; ========== Begin Checks =============== ; Checking CPU (...)

; Checking GPT (...)

- [ ] Improve script order (Main part):

Global vars
Includes
Options
Check OS
Init Gui part or command line part

run checks for command line or gui


# Folder/file structure
- [ ] Align naming: All upper case or all lower case.
- [ ] Move source code (*.au3, include, lang, assets) into folder `/src`.
- [ ] Fix include commands
- [x] Fix Wrapper_Add_Icon commands path.

@rcmaehl This would help other contributors to fast understanding the code. I would do it. But this makes no sense because this is inkompatibel to other commits.

micwoj92 commented 3 years ago

Could you format points as [ ] ? That way it would be easier to tell progress. I assume that it's unlikely to so such big task all at once.

htcfreek commented 3 years ago

@micwoj92 Done!

micwoj92 commented 3 years ago

Should I assign this to you?

rcmaehl commented 3 years ago

Should I assign this to you?

Me

htcfreek commented 3 years ago

Updated main comment.

micwoj92 commented 3 years ago

@rcmaehl you can assign yourself :P

htcfreek commented 3 years ago

@rcmaehl We should use the same naming structure for the same type of include. This means Resources.au3 should be _Resources.au3.

htcfreek commented 3 years ago

@rcmaehl

Your includes are broken. (See fix here: https://github.com/htcfreek/WhyNotWin11/commit/9a24e7d6a2e446e0e8d5973475a66b20dfa8eeb0)
The lang copy is broken. It crashed my changed lang files. (Don't know why.)

micwoj92 commented 3 years ago

As far as I know you are using this IDE called "ISN AutoIt Studio" while Robert uses Scite4Autoit, could you try with Scite and see if it still is issue?

htcfreek commented 3 years ago

As far as I know you are using this IDE called "ISN AutoIt Studio" while Robert uses Scite, could you try with Scite and see if it still is issue?

The includes are working now. The error came from Wrapper and tidy.
The lang files aren't broken. But the doesn't get read.

Let me work tomorrow on this. It's time for sleeping. 😅

htcfreek commented 3 years ago

@rcmaehl Csn you please stop doing this .\ things while including. This breaks code. You need "Includes\...au3".

See here: https://www.autoitscript.com/autoit3/docs/keywords/include.htm

htcfreek commented 3 years ago

@rcmaehl I have added a new group "Folder/file structure" to the checklist.

micwoj92 commented 3 years ago

How does that break?

htcfreek commented 3 years ago

@micwoj92 The include files/assets aren't found/included. Wrapper and Check saying that files aren't available.

htcfreek commented 3 years ago

@micwoj92 Can you please add "In-progress" lable.

micwoj92 commented 2 years ago

Has there been any progress on this in ~1 year?

rcmaehl / WhyNotWin11