Review of TLuaInterpreter.cpp

[JorMox]

I went through TLuaInterpreter.cpp looking for functions that still don't handle "main" as a window argument appropriately, and found a significant number of issues in the process, which I'll try to detail below.

First, functions that don't accept "main" as a window argument.

• setBgColor
• setFgColor
• cut
• setWindowWrapIndent
• getLineCount
• getColumnNumber
• replace
• deleteLine
• echoUserWindow
• setLink
• insertPopup
• insertText
• insertHTML
• echoLink

Next, functions that require "main" as a window argument to work in the main window.

• setWindowWrap
• getLastLineNumber
• setPopup

Next, functions that are public, but not documented in the wiki.

• loadRawFile
• removeMapMenu
• getMapMenus
• cut
• setWindowWrapIndent
• setMapperView
• auditAreas
• getAllAreaUserData
• insertHTML
• setMergeTables
• pasteWindow
• setDefaultAreaVisible

Next, functions that are mentioned as being public, but aren't.

• dirToString
• dirToNumber

Next, functions that, based on a discussion with Vadi, were handling a "main" window argument in some way other than the "right" way.

• selectString
• selectCurrentLine
• getFgColor
• getBgColor
• wrapLine
• getCurrentLine
• getLineNumber
• copy
• paste
• moveCursor
• setConsoleBufferSize
• deselect
• resetFormat
• moveCursorEnd
• getLastLineNumber
• insertLink
• echo

And finally, assorted issues I noticed that don't fit well into any particular category.

• setWindowWrapIndent - doesn't seem to do anything, might be using it wrong -> setWindowWrapIndent('window', spaces_to_indent)
• enableScrollBar - does nothing with either "main" or no argument, no errors
• disableScrollBar does nothing with either "main" or no argument, no errors
• createButton - //TODO FIXME
• closeUserWindow - apparently intentionally undocumented
• hideUserWindow - publicly available as "hideWindow", uses "hideUserWindow" in error message
• showUserWindow - publicly available as "showWindow", uses "showUserWindow" in error message
• solveRoomCollisions - apparently does nothing. entire function is just "return 0;"
• deselect - mentions not yet handling non-ASCII window names
• resetFormat - mentions not yet handling non-ASCII window names
• tempButtonToolbar - all errors for wrong arg types reference first arg
• getRoomChar - says it isn't documented, but it is
• insertPopup - documentation has a messed up argument documented
• insertHTML - doesn't seem to act as expected? may be using it wrong

Note: This isn't intended to be a comprehensive list of issues in the file (I'm fairly certain I saw several places that don't use UTF-8 that probably should, for example), but these are all things I was confident about.

[Kebap]

About public/documented functions, I had a stab at it a while ago as well. Happy to see the ball picked up again. Feel free to review my notes here: https://wiki.mudlet.org/w/User:Kebap/documentation-in-wiki