FREE UTILITY: AMS Code Pretty

[CyberRBT]

A while back I posted a quick function in one of the threads in answer to a request for help. By hand, I highlighted the syntax of the code so that it was easily readable. Maybe you've had a similar experience.

I then searched for a utility that would do this automatically. When I couldn't find one, I wrote one (in AMS). This file, AMS Code Pretty, is my donation to the AMS community. It was put together over the last four days in my spare time (about 20 hours).

Once the lexer engine was coded, it was a small step to also provide a functionality to convert AMS/LUA code to HTML. The program does this as well, plus more.

The following is a sample output. Notice the line numbers; this is one of several user-definable features.

01 
02 [b][COLOR='#0000FF']function[/COLOR][/b] appPathOriginal[COLOR='#FF0000']([/COLOR][COLOR='#FF0000'])[/COLOR] 
03 [i][COLOR='#008000']	-- returns the original EXE's path ONLY (with trailing \)[/COLOR][/i]
04 [i][COLOR='#008000']	-- this is useful for compressed single-file apps run from a CD[/COLOR][/i]
05 [i][COLOR='#008000']	-- but, it also works with folder-based apps[/COLOR][/i]
06 
07 	[b][COLOR='#0000FF']local[/COLOR][/b] cdPath [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']""[/COLOR]; 
08 	[b][COLOR='#0000FF']local[/COLOR][/b] findMarker [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"SFXSOURCE:"[/COLOR]; 
09 	[b][COLOR='#0000FF']local[/COLOR][/b] cmdArgs [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']""[/COLOR]; 
10 
11 	[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]Table[COLOR='#FF0000'].[/COLOR]Count[COLOR='#FF0000']([/COLOR]_CommandLineArgs[COLOR='#FF0000'])[/COLOR] [COLOR='#FF0000']>[/COLOR] 0[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
12 		[b][COLOR='#0000FF']for[/COLOR][/b] i [COLOR='#FF0000']=[/COLOR] 1[COLOR='#FF0000'],[/COLOR] Table[COLOR='#FF0000'].[/COLOR]Count[COLOR='#FF0000']([/COLOR]_CommandLineArgs[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']do[/COLOR][/b] 
13 			[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]String[COLOR='#FF0000'].[/COLOR]Find[COLOR='#FF0000']([/COLOR]_CommandLineArgs[COLOR='#FF0000'][[/COLOR]i[COLOR='#FF0000']][/COLOR][COLOR='#FF0000'],[/COLOR] findMarker[COLOR='#FF0000'])[/COLOR] [COLOR='#FF0000']>[/COLOR] 0[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
14 				cmdArgs [COLOR='#FF0000']=[/COLOR] _CommandLineArgs[COLOR='#FF0000'][[/COLOR]i[COLOR='#FF0000']][/COLOR]; 
15 				break; 
16 			[b][COLOR='#0000FF']end[/COLOR][/b] 
17 		[b][COLOR='#0000FF']end[/COLOR][/b] 
18 	[b][COLOR='#0000FF']end[/COLOR][/b] 
19 
20 	[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]cmdArgs [COLOR='#FF0000']~[/COLOR][COLOR='#FF0000']=[/COLOR] [COLOR='#800080']""[/COLOR][COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
21 		[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]String[COLOR='#FF0000'].[/COLOR]Find[COLOR='#FF0000']([/COLOR]cmdArgs[COLOR='#FF0000'],[/COLOR] findMarker[COLOR='#FF0000'])[/COLOR] [COLOR='#FF0000']=[/COLOR][COLOR='#FF0000']=[/COLOR] 1[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
22 			[b][COLOR='#0000FF']local[/COLOR][/b] fullPath [COLOR='#FF0000']=[/COLOR] String[COLOR='#FF0000'].[/COLOR]Replace[COLOR='#FF0000']([/COLOR]cmdArgs[COLOR='#FF0000'],[/COLOR] findMarker[COLOR='#FF0000'],[/COLOR] [COLOR='#800080']""[/COLOR][COLOR='#FF0000'],[/COLOR] true[COLOR='#FF0000'])[/COLOR]; 
23 			[b][COLOR='#0000FF']local[/COLOR][/b] tblFullPath [COLOR='#FF0000']=[/COLOR] String[COLOR='#FF0000'].[/COLOR]SplitPath[COLOR='#FF0000']([/COLOR]fullPath[COLOR='#FF0000'])[/COLOR]; 
24 			cd_Path [COLOR='#FF0000']=[/COLOR] tblFullPath[COLOR='#FF0000'].[/COLOR]Drive [COLOR='#FF0000'].[/COLOR][COLOR='#FF0000'].[/COLOR] tblFullPath[COLOR='#FF0000'].[/COLOR]Folder; 
25 		[b][COLOR='#0000FF']end[/COLOR][/b] 
26 	[b][COLOR='#0000FF']else[/COLOR][/b] 
27 		cd_Path [COLOR='#FF0000']=[/COLOR] _SourceFolder [COLOR='#FF0000'].[/COLOR][COLOR='#FF0000'].[/COLOR] [COLOR='#800080']"\\";"[/COLOR]
28 	[b][COLOR='#0000FF']end[/COLOR][/b] 
29 	[b][COLOR='#0000FF']return[/COLOR][/b] cd_Path; 
30 [b][COLOR='#0000FF']end[/COLOR][/b] 
31

The download installs and starts it for you. I'm interested to know if anyone else finds this utility useful. Questions, comments, and suggestions are welcome.



AMS_Code_Pretty_1.0.3_Install.exe

[RizlaUK]

Hey, nice work, :yes :yes :yes

this is something i can make good use of, and i urge anyone that posts code in the forum to use this well handy little tool


Nice Work CyberRBT, And Thanks

[CyberRBT]

Thank you. There is a LOT of code in the posts here. Maybe a utility like this will help make it easier to follow.

I have discovered a minor bug in the lexer engine. It is now fixed. Before, if you had two quoted backslashes alone, the output added an extra quote.

The current version is 1.0.3.2. If you were one of the two dozen or so who DL'd right after the above link was posted, you may want to grab this latest update. When you do, make sure that the older version is not running (exit from the system tray) and you may also want to uninstall it (not required though).

The link above is valid for the latest version.

Line #27 in the source code sample above reveals the minor bug. Now, look at the following which demonstrates the fix.

01 
02 [b][COLOR='#0000FF']function[/COLOR][/b] appPathOriginal[COLOR='#FF0000']([/COLOR][COLOR='#FF0000'])[/COLOR] 
03 [i][COLOR='#008000']	-- returns the original EXE's path ONLY (with trailing \)[/COLOR][/i]
04 [i][COLOR='#008000']	-- this is useful for compressed single-file apps run from a CD[/COLOR][/i]
05 [i][COLOR='#008000']	-- but, it also works with folder-based apps[/COLOR][/i]
06 
07 	[b][COLOR='#0000FF']local[/COLOR][/b] cdPath [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']""[/COLOR]; 
08 	[b][COLOR='#0000FF']local[/COLOR][/b] findMarker [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"SFXSOURCE:"[/COLOR]; 
09 	[b][COLOR='#0000FF']local[/COLOR][/b] cmdArgs [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']""[/COLOR]; 
10 
11 	[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]Table[COLOR='#FF0000'].[/COLOR]Count[COLOR='#FF0000']([/COLOR]_CommandLineArgs[COLOR='#FF0000'])[/COLOR] [COLOR='#FF0000']>[/COLOR] 0[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
12 		[b][COLOR='#0000FF']for[/COLOR][/b] i [COLOR='#FF0000']=[/COLOR] 1[COLOR='#FF0000'],[/COLOR] Table[COLOR='#FF0000'].[/COLOR]Count[COLOR='#FF0000']([/COLOR]_CommandLineArgs[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']do[/COLOR][/b] 
13 			[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]String[COLOR='#FF0000'].[/COLOR]Find[COLOR='#FF0000']([/COLOR]_CommandLineArgs[COLOR='#FF0000'][[/COLOR]i[COLOR='#FF0000']][/COLOR][COLOR='#FF0000'],[/COLOR] findMarker[COLOR='#FF0000'])[/COLOR] [COLOR='#FF0000']>[/COLOR] 0[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
14 				cmdArgs [COLOR='#FF0000']=[/COLOR] _CommandLineArgs[COLOR='#FF0000'][[/COLOR]i[COLOR='#FF0000']][/COLOR]; 
15 				break; 
16 			[b][COLOR='#0000FF']end[/COLOR][/b] 
17 		[b][COLOR='#0000FF']end[/COLOR][/b] 
18 	[b][COLOR='#0000FF']end[/COLOR][/b] 
19 
20 	[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]cmdArgs [COLOR='#FF0000']~[/COLOR][COLOR='#FF0000']=[/COLOR] [COLOR='#800080']""[/COLOR][COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
21 		[b][COLOR='#0000FF']if[/COLOR][/b] [COLOR='#FF0000']([/COLOR]String[COLOR='#FF0000'].[/COLOR]Find[COLOR='#FF0000']([/COLOR]cmdArgs[COLOR='#FF0000'],[/COLOR] findMarker[COLOR='#FF0000'])[/COLOR] [COLOR='#FF0000']=[/COLOR][COLOR='#FF0000']=[/COLOR] 1[COLOR='#FF0000'])[/COLOR] [b][COLOR='#0000FF']then[/COLOR][/b] 
22 			[b][COLOR='#0000FF']local[/COLOR][/b] fullPath [COLOR='#FF0000']=[/COLOR] String[COLOR='#FF0000'].[/COLOR]Replace[COLOR='#FF0000']([/COLOR]cmdArgs[COLOR='#FF0000'],[/COLOR] findMarker[COLOR='#FF0000'],[/COLOR] [COLOR='#800080']""[/COLOR][COLOR='#FF0000'],[/COLOR] true[COLOR='#FF0000'])[/COLOR]; 
23 			[b][COLOR='#0000FF']local[/COLOR][/b] tblFullPath [COLOR='#FF0000']=[/COLOR] String[COLOR='#FF0000'].[/COLOR]SplitPath[COLOR='#FF0000']([/COLOR]fullPath[COLOR='#FF0000'])[/COLOR]; 
24 			cd_Path [COLOR='#FF0000']=[/COLOR] tblFullPath[COLOR='#FF0000'].[/COLOR]Drive [COLOR='#FF0000'].[/COLOR][COLOR='#FF0000'].[/COLOR] tblFullPath[COLOR='#FF0000'].[/COLOR]Folder; 
25 		[b][COLOR='#0000FF']end[/COLOR][/b] 
26 	[b][COLOR='#0000FF']else[/COLOR][/b] 
27 		cd_Path [COLOR='#FF0000']=[/COLOR] _SourceFolder [COLOR='#FF0000'].[/COLOR][COLOR='#FF0000'].[/COLOR] [COLOR='#800080']"\\"[/COLOR]; 
28 	[b][COLOR='#0000FF']end[/COLOR][/b] 
29 	[b][COLOR='#0000FF']return[/COLOR][/b] cd_Path; 
30 [b][COLOR='#0000FF']end[/COLOR][/b] 
31

Again, the link above is valid for the latest version. And, questions, comments, and suggestions are welcome.

[RizlaUK]

thanks for the update :yes

iv just one small suggestion/request

when useing the bbcode setting the output is actual bbcode, could you add a button to switch between the actual bbcode and prazed bbocde so we could still see the ams type of code in the preview useing bbcode settings and click the button to see the actual bbocde

just for visual effect as i always like to check how the output will look b4 posting

[CyberRBT]

Sure. I can put that feature in the next update.

But, for now you can preview as HTML to see the results. The visual output for the end-user is the same whether it's HTML or BB Code.

[Worm]

Sure is purty

very nice!

[Adam]

Nice App. I like it

For a future version I wonder if it would be possible to insert the proper indenting? It drives me nuts when code is not indented at if, for statements.

Adam Kapilik

[Worm]

I agree, it makes the code so much easier to read.

[RizlaUK]

But, for now you can preview as HTML to see the results. The visual output for the end-user is the same whether it's HTML or BB Code.

yeah good point, but how about putting the checkbox for the output setting on the main interface, that way i could view as html and quickly view as bbcode without haveing to go in to the settings, that would proberly be easyer that way

I agree, it makes the code so much easier to read.

ditto, i only recently learned the importance of indenting my code, also i only just found that i could put small blocks on one line :

01 [b][COLOR='#0000FF']if[/COLOR][/b] something [b][COLOR='#0000FF']then[/COLOR][/b] dosomething [b][COLOR='#0000FF']else[/COLOR][/b] dont_dosomething [b][COLOR='#0000FF']end[/COLOR][/b]

makes things look a lot more tidy

[Intrigued]

You're getting feedback, suggestions. Good sign. :yes

[CyberRBT]

Intrigued:
You're getting feedback, suggestions. Good sign.

Hey. This post went live today around 10:30 a.m.; it took about a day for the staff to approve it. And ... i've had 37 DL's in first few hours with 100 views here. Thanks, one and all, for trying it ... and for your suggestions.

RizlaUK:
...but how about putting the checkbox for the output setting on the main interface...

That is exactly how I envisioned doing what you'd suggested earlier. That update will be available soon.

Adam:
For a future version I wonder if it would be possible to insert the proper indenting? It drives me nuts when code is not indented at if, for statements.

Programming keeps my in touch with my inner Type-A. These days, I'm a fanatic about indenting blocks ... and about naming conventions ... all Label names begin with 'lbl_', all ComboBox names begin with 'cbo_', etc. I also comment liberally (after debuging). Over the years, I've learned (the hard way) that following these guidelines makes updating later SO much easier.

Nonetheless, with the lexer engine the focus is on isolating keywords and syntax, then highlighting them accordingly. Indention, like naming conventions, is a choice of style. Although, I may add an indention feature, at this juncture I'm not quite sure how to properly handle nested blocks.

[Intrigued]

How do you feel about sharing an exported version of this utility (.apz)?

[CyberRBT]

Well ... the project is still in development. But, the help file does give clues on how to get the source code. Nonetheless, I wouldn't want the lexer engine source posted at this time. However, clever programmers (such as yourself Intrigued) could acquire it and use it in their own projects (as long as the AMS lexer engine source is not disclosed).

BTW, writing this type of code using regular expressions and a RichEdit control takes a few dozen lines of code. Using AMS to syntax highlight AMS code took over 300 lines.

Here is a list of the functions in the latest update. You can use these prototypes after you load the bytecode compiled script (code_pretty.luac). The parameter for the 'pretty_lines()' function is a table of source code lines.

[b][COLOR='#0000FF']function[/COLOR][/b] isCharAlpha[COLOR='#FF0000']([/COLOR]char_test[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] isKeyword[COLOR='#FF0000']([/COLOR]str_test[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] prefix_lineNbr[COLOR='#FF0000']([/COLOR]nbr[COLOR='#FF0000'],[/COLOR] maxlines[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] prep_punctuation_all[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] [i][COLOR='#008000'] -- the easy punctuation[/COLOR][/i]
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_comment[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_keyword[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_lines[COLOR='#FF0000']([/COLOR]this_lua[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_lines_function_list[COLOR='#FF0000']([/COLOR]this_lua[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_lines_ini_file[COLOR='#FF0000']([/COLOR]this_ini[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_lines_xml_file[COLOR='#FF0000']([/COLOR]this_xml[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_one_line[COLOR='#FF0000']([/COLOR]str_in[COLOR='#FF0000'])[/COLOR] [i][COLOR='#008000'] -- the big one[/COLOR][/i]
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_punctuation[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_quoted[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_xml_tag_left[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] pretty_xml_tag_right[COLOR='#FF0000']([/COLOR]in_str[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] sort_no_case[COLOR='#FF0000']([/COLOR]v1[COLOR='#FF0000'],[/COLOR] v2[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] StringToTable[COLOR='#FF0000']([/COLOR]DelimitedString[COLOR='#FF0000'],[/COLOR] Delimiter[COLOR='#FF0000'])[/COLOR] 
[b][COLOR='#0000FF']function[/COLOR][/b] xlate_FShtmlToBB[COLOR='#FF0000']([/COLOR][COLOR='#FF0000'])[/COLOR]

BTW, alphabetic function list output as displayed (to HTML or BB Code) is a new feature.

And, here are the global variables required by the engine:

[b][COLOR='#0000FF']function[/COLOR][/b] restore_defaults[COLOR='#FF0000']([/COLOR][COLOR='#FF0000'])[/COLOR] 
	convert_to_html [COLOR='#FF0000']=[/COLOR] true; 
	html_fontsize [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"9"[/COLOR]; 
	number_lines [COLOR='#FF0000']=[/COLOR] true; 
	
	comment_color [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"#008000"[/COLOR]; 
	comment_italic [COLOR='#FF0000']=[/COLOR] true; 
	comment_bold [COLOR='#FF0000']=[/COLOR] false; 
	
	quoted_color [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"#800080"[/COLOR]; 
	quoted_italic [COLOR='#FF0000']=[/COLOR] false; 
	quoted_bold [COLOR='#FF0000']=[/COLOR] false; 
	
	keyword_color [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"#0000FF"[/COLOR]; 
	keyword_italic [COLOR='#FF0000']=[/COLOR] false; 
	keyword_bold [COLOR='#FF0000']=[/COLOR] true; 
	
	punctuation_color [COLOR='#FF0000']=[/COLOR] [COLOR='#800080']"#FF0000"[/COLOR]; 
	punctuation_italic [COLOR='#FF0000']=[/COLOR] false; 
	punctuation_bold [COLOR='#FF0000']=[/COLOR] false; 

	settings_save[COLOR='#FF0000']([/COLOR][COLOR='#FF0000'])[/COLOR];	 
[b][COLOR='#0000FF']end[/COLOR][/b]

[CyberRBT]

Okay. Here is another update. Now i'm going to wait for a while before updating the application while collecting a list of suggested improvements. Help / About apprises you of your installed version number.

The link in the intial post will DL the latest version.

The current version is now 1.0.3.4. When you install this update, make sure that the older version is not running (exit from the system tray) and you may also want to uninstall it (not required though).

Since AMS supports INI and XML files, I added a feature to open them and syntax highlight to HTML or BB Code. The HTML conversion is good for placing in the BODY of a Web page or in a help file.

Here are the updates:

1.0.3.4 (2007-04-03)

- HTML font sizes now alter BB Code too: HTML '7' is BB 1, HTML '8' is BB 2, HTML '9' is BB 3 (the defaults), HTML '10' is BB 4, and so on.

- New feature. In addition to conversion styles (HTML or BB Code), conversion types are now supported. They include: (1) All LUA Code,
(2) Function List, (3) Function List Sorted, (4) INI File, and (5) XML File.

1.0.3.3 (2007-04-02)

- enhanced the visual contrast between active and inactive wizard tabs

- added an HTML checkbox to the “Output Preview” page (suggested by RizlaUK above)

- implemented minor design enhancements to the “Output Settings” page

- to the “Help” page added Reference Sections: “AMS Sites” and “Coding Style” (the Coding Style topic was broached by Adam above)

[Intrigued]

BTW, writing this type of code using regular expressions and a RichEdit control takes a few dozen lines of code. Using AMS to syntax highlight AMS code took over 300 lines.

These may come in handy, as I noticed your comment:

http://lua-users.org/wiki/ExpressionsTutorial

http://lua-users.org/wiki/StringInterpolation

http://lua-users.org/wiki/StringLibraryTutorial

Thanks for sharing the parts you did. I like to see how others are coding. This helps me to make sure I'm coding the best I can and to find some new insights, tips that others are using.

:yes