Fix various typos and spelling mistakes

[ZoeB]

I'm purposefully leaving /src/emu/bus/cbmiec/c1541.c's kernal.bin
as it is, as this particular spelling mistake was originally made
by Robert Russell, therefore is canon. See
http://en.wikipedia.org/wiki/KERNAL for details.

I'm also leaving /src/emu/machine/nscsi_bus.c's RECIEVE as I don't
want to break anything, but it's worth someone looking into.

I renamed some variables in /src/mame/drivers/sfbonus.c,
/src/mame/video/tia.c and /src/mame/video/tia.h, so if anyone wants
to verify I didn't break anything, that would be nice.

[cuavas]

Third Millenium Engineering is a trademark and is spelled with a single 'n'. Please check properly before attempting to 'correct' the spelling of names/trademarks.

[balr0g]

I don't know if I would call "publically" legitimate. Most authoritative sources consider it at least nonstandard, and many consider it wrong.

"Third Millenium" is correct as-is — see http://apple2info.net/index.php?title=The_Arcade_Board .

As for variable renames: I'm not sure how the developers other than @cuavas feel about this, but personally it really irks me if I'm working with code with such misspellings. And variable names change pretty-frequently as-is. Personally I'd rather have correctly spelled variable names over the temporary convenience of not having to refresh autocomplete data.

[ghost]

I agree. unless there is a legitimate US/UK spelling difference, the
spelling of any dictionary word, including variable names should be correct.

Guru

On Sat, Apr 11, 2015 at 9:04 AM, balr0g notifications@github.com wrote:

I don't know if I would call "publically" legitimate. Most authoritative
sources consider it at least nonstandard, and many consider it wrong.

"Third Millenium" is correct as-is — see
http://apple2info.net/index.php?title=The_Arcade_Board .

As for variable renames: I'm not sure how the developers other than
@cuavas https://github.com/cuavas feel about this, but personally it
really irks me if I'm working with code with such misspellings. And
variable names change pretty-frequently as-is. Personally I'd rather have
correctly spelled variable names over the temporary convenience of not
having to refresh autocomplete data.

—
Reply to this email directly or view it on GitHub
#159 (comment).

[cuavas]

Messing with variable and function names also has greater chance of causing conflicts when people are working on the code, and causing unintended side-effects if you unintentionally end up shadowing a global or member. I still don't think it's a good idea to just change variable names when you aren't doing any other work on the code, but if you're going to, at the very least do a build with -Wshadow and test affected drivers.

[ghost]

if a full source-wide rename is done there shouldn't be issues since all
affected variables are renamed.
I seem to recall Aaron did this many times in the past. Sure he was working
on the code but it's still just a variable renamed and if all of them are
changed through the entire source codebase it functions exactly the same as
before the rename. only now it looks more professional because the spelling
is correct ;-)

On Sat, Apr 11, 2015 at 3:28 PM, Vas Crabb notifications@github.com wrote:

Messing with variable and function names also has greater chance of
causing conflicts when people are working on the code, and causing
unintended side-effects if you unintentionally end up shadowing a global or
member. I still don't think it's a good idea to just change variable names
when you aren't doing any other work on the code, but if you're going to,
at the very least do a build with -Wshadow and test affected drivers.

—
Reply to this email directly or view it on GitHub
#159 (comment).

[ZoeB]

Huh. They spelt Millennium correctly on the PCB: http://apple2info.net/images/thumb/3/3d/TME_ArcadeBoard.jpg/480px-TME_ArcadeBoard.jpg I guess they weren't too consistent. :) Reverting...

[ZoeB]

I've reverted the Millennium fix, the publicly fix, and the variable fix, so you can pick and choose (or, rather, cherry-pick and squash) which of these you'd like and which you wouldn't.

[cuavas]

@mr-t-guru a global rename can still cause a shadowing issue. Suppose there's a more global variable called "address" and a more local variable called "addres". The incorrectly spelled variable doesn't shadow the correctly spelled one. But if you rename "addres" to "address" you create a shadowing issue even if you catch all occurrences of it, as any code where the variable formerly known as "addres" is in scope that tries to access the more global variable will access the more local variable instead as they now have the same name.

[happppp]

all the bla aside, the "catagory" variable typo is ok to fix :|
The COLUM one: well, a quick look tells me there's M and P, COLUP and COLUM

On Sat, Apr 11, 2015 at 2:49 PM, Vas Crabb notifications@github.com wrote:

@mr-t-guru https://github.com/mr-t-guru a global rename can still cause
a shadowing issue. Suppose there's a more global variable called "address"
and a more local variable called "addres". The incorrectly spelled variable
doesn't shadow the correctly spelled one. But if you rename "addres" to
"address" you create a shadowing issue even if you catch all occurrences of
it, as any code where the variable formerly known as "addres" is in scope
that tries to access the more global variable will access the more local
variable instead as they now have the same name.

—
Reply to this email directly or view it on GitHub
#159 (comment).

[ZoeB]

Ack, you're right, COLUM should stay as it is! Nice catch, thanks. I'll make a version with "catagory" changed but COLUM left well alone, on the offchance that's a combination that would be more useful. Again, feel free to cherry pick and squash / rebase these as needed to only keep the good changes.

[ghost]

the solution is to plan and be smarter from the start and to NOT use
keywords or commonly used computer terms as variables. If you want to use
some common computer-word like "address" as a variable you are just asking
for trouble. If you miss-spell it and continue to use the miss-spelled
version multiple times that is just lazy or stupid (or both).
hence the use of long obscure multi-word variables through-out MAME that
are easily mass-renamed without errors.
anyway I'm not going to argue with you about it. She should probably just
stick with non-code changes/corrections anyway because she doesn't have a
MAME-background or knowledge of the MAME-Way(tm)

On Sat, Apr 11, 2015 at 8:49 PM, Vas Crabb notifications@github.com wrote:

@mr-t-guru https://github.com/mr-t-guru a global rename can still cause
a shadowing issue. Suppose there's a more global variable called "address"
and a more local variable called "addres". The incorrectly spelled variable
doesn't shadow the correctly spelled one. But if you rename "addres" to
"address" you create a shadowing issue even if you catch all occurrences of
it, as any code where the variable formerly known as "addres" is in scope
that tries to access the more global variable will access the more local
variable instead as they now have the same name.

—
Reply to this email directly or view it on GitHub
#159 (comment).

[cuavas]

In an ideal world things no-one would repeat a misspelling, but it isn't an ideal world:

• People use editors/IDEs with autocomplete, so when you're working at speed you misspell the name once in the declaration, then use autocomplete each time you use it, so you don't notice the misspelling because you don't have to type it out each time. This is far easier to do with long names than short ones due to clutter factor.
• MAME code is in English and many MAME developers are non-native speakers. Many spelling errors are honest mistakes. These tend to be done consistently throughout a given developer's work. If you want all contributors to be fluent English speakers you're going to lose a lot of people.
• Even with English speakers, you can end up with regional spelling differences causing equivalently named symbols to end up in scope, e.g. colour/color and centre/center.

Giving variables overly verbose names doesn't help. If you have a bus write handler, you're going to name the parameters something along the lines of address, data and mask. In fact, that's what MAME's core macros enforce: your parameters are called address_space, offset, data and mem_mask. Terse names are easy to understand and use.

Shadowing can be avoided by using conventions like prefixing member names with m_ and global names with g_, but some people on the team find this style distasteful. Ultimately we should be building with -Wshadow all the time - it would alert us to a lot of potential problems before they become real headaches. The trouble is, MAME has gone far too long without this, so it causes a huge number of warnings, and it will take a long time to go through and address them all before -Wshadow can be enabled by default.

[ghost]

so it should be done. MAME can't get any worse ;-)
Maybe ZoeB can look into it and make a real improvement so we can eventually enable -Wshadow