[NOPE] Forming code style standard guidelines

[ilmarinen]

You know it has to be done, in some way.

First thing I suggest just to pick most freequent appearance of one or another style for lexical unit.

Or we can vote on using pre-defined by someone else code style, such as:

• “gnu”: The default style for GNU projects

• “k&r”: What Kernighan and Ritchie, the authors of C used in their book

• “bsd”: What BSD developers use, aka “Allman style” after Eric Allman.

• “whitesmith”: Popularized by the examples that came with Whitesmiths C, an early commercial C compiler.

• “stroustrup”: What Stroustrup, the author of C++ used in his book

• “ellemtel”: Popular C++ coding standards as defined by “Programming in C++, Rules and Recommendations,” Erik Nyquist and Mats Henricson, Ellemtel

• “linux”: What the Linux developers use for kernel development

• “python”: What Python developers use for extension modules

Examples of corresponding styles are shown in this Wiki article.

On the question of tabs vs spaces spaces (gladly ) have won, among current developers and in retrospective.
On the question of two vs four spaces four scapes (sadly) have won.

[ilmarinen]

Instead of using poll I suggest we just talk.
I really don't care which style you pick up, because my editor is so superior to yours it reformats code style for me

[lujke]

My cards on the table: I don't know any of those code styles, and I'm a bit daunted by the prospect of having to learn something new. I understand it's a reaonable enough idea, but my RL involves a lot of academic pressure at the moment, so my coding is a release valve: I don't want it to start feeling like work...

[ilmarinen]

Its not going to be enforced... Besides, we have 4 million lines of code, that just impossible.
Just pick what you like most, mewbe, so others can suffer from your decision, and you'll be left to lizardy thingies?

[nienne]

I am quite happy with spaces, and four of them

I tend to have a standard pattern but I know it doesn't match some others (eg/ Saide/Ares use quite different bracket placement). I didn't really think much beyond my own standard feeding my OCD, as per Lujke I didn't really know there's all these different "ways" or whatever. I think mine is one of the java/c++ ones. k&r maybe? Given I learned java coding first in school, that's probably why.

[ramius]

So I'm not a real coder, just someone who reads code and sorta translates it for others. My question is this: Is there a mass bash script we can run to standardize all code and put it in a format where standardization is easier (cause if this guy did it, I should do it too)?

[ilmarinen]

So I'm not a real coder[...]

I can do it for tabs vs spaces issue at least... For the other stuff like

Code: Select all

if(blep) {
    mlem;
}

vs

Code: Select all

if(blep)
{
    mlem;
}

its not that trivial.

[circe]

I learned from Styx, who was super strict on coding format back in the day, and I tend to "correct" other code as I'm fixing bugs or whatever (whether I intend to or not). My bracket style is totally K&R, and I use three spaces for the "indent" when needed. I also have very strong ideas about 40 characters per line and similar stuff thanks to my training from 16ish years ago

[ilmarinen]

I learned from Styx, who was super strict on coding format back in the day, and I tend to "correct" other code as I'm fixing bugs or whatever (whether I intend to or not). My bracket style is totally K&R, and I use three spaces for the "indent" when needed. I also have very strong ideas about 40 characters per line and similar stuff thanks to my training from 16ish years ago

72 characters per line used to be the standard, as most terminals were only 80 characters wide. Something inherited from F66 age. 40 is some homebrew nonsense.
But that could not have been sg's early standard? "" "" wastes cpu time on concatenation.
I'd strongly advise not to do too many concatinations and use line wrapping feature of your editor insted. It's not only about saving tiny bits of cpu cycles but concerns formatting as well. Especially if it about help files -- line breaks you have for yourself might not correspond with line breaks client has set on their side either via SCREEN env variable or line breaking introduced by their client.

[circe]

Will do (or will try to do). I know before we had problems with text blocks that were too long (without concatenation) not showing part of the string, particularly in room descriptions and the like, but also in text/help files.

[odin]

When I rewrite the help statname files to make them 3.5 compatible I didn't use any line breaks... (nevermind, I see that I wasn't supposed to do any concatenations)

[garrett]

I don't care how you write things, as long as we're not going down the road of the Obfuscated C Contest: https://www.ioccc.org/

The only heinous part of the code that I've written and care to admit was the code that determines how fast weapons decay. I am still so ashamed of that code.

[odin]

Then fix it.

[ilmarinen]

Example:

Code: Select all

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Dolor sed
viverra ipsum nunc aliquet bibendum enim.  In massa tempor nec
feugiat. Nunc aliquet bibendum enim facilisis gravida. Nisl nunc mi
ipsum faucibus vitae aliquet nec ullamcorper. Amet luctus venenatis
lectus magna fringilla.  Volutpat maecenas volutpat blandit aliquam
etiam erat velit scelerisque in. Egestas egestas fringilla phasellus
faucibus scelerisque eleifend.  Sagittis orci a scelerisque purus
semper eget duis.  Nulla pharetra diam sit amet nisl suscipit. Sed
adipiscing diam donec adipiscing tristique risus nec feugiat in. Fusce
ut placerat orci nulla.  Pharetra vel turpis nunc eget lorem
dolor. Tristique senectus et netus et malesuada.

will appear okay on terminals with width of 70+, but on terminals wit width <70 you'll see stuff like:

Code: Select all

Lorem ipsum dolor sit amet, consectetur
adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore
magna aliqua. Dolor sed
viverra ipsum nunc aliquet bibendum enim.
In massa tempor nec
feugiat. Nunc aliquet bibendum enim facilisis
gravida. Nisl nunc mi
ipsum faucibus vitae aliquet nec
ullamcorper. Amet luctus venenatis
lectus magna fringilla.  Volutpat maecenas
volutpat blandit aliquam
etiam erat velit scelerisque in. Egestas egestas
fringilla phasellus
faucibus scelerisque eleifend.  Sagittis orci
a scelerisque purus
semper eget duis.  Nulla pharetra diam sit amet
nisl suscipit. Sed
adipiscing diam donec adipiscing tristique risus
nec feugiat in. Fusce
ut placerat orci nulla.  Pharetra vel turpis
nunc eget lorem
dolor. Tristique senectus et netus et malesuada.

That's just 50 symbols width.

Text typed as

Code: Select all

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Dolor sed viverra ipsum nunc aliquet bibendum enim. In massa tempor nec feugiat. Nunc aliquet bibendum enim facilisis gravida. Nisl nunc mi ipsum faucibus vitae aliquet nec ullamcorper. Amet luctus venenatis lectus magna fringilla. Volutpat maecenas volutpat blandit aliquam etiam erat velit scelerisque in. Egestas egestas fringilla phasellus faucibus scelerisque eleifend. Sagittis orci a scelerisque purus semper eget duis. Nulla pharetra diam sit amet nisl suscipit. Sed adipiscing diam donec adipiscing tristique risus nec feugiat in. Fusce ut placerat orci nulla. Pharetra vel turpis nunc eget lorem dolor. Tristique senectus et netus et malesuada.

Will appear as

Code: Select all

Lorem ipsum dolor sit amet, consectetur
adipiscing elit, sed do eiusmod tempor incididunt
ut labore et dolore magna aliqua. Dolor sed
viverra ipsum nunc aliquet bibendum enim. In
massa tempor nec feugiat. Nunc aliquet bibendum
enim facilisis gravida. Nisl nunc mi ipsum
faucibus vitae aliquet nec ullamcorper. Amet
luctus venenatis lectus magna fringilla. Volutpat
maecenas volutpat blandit aliquam etiam erat
velit scelerisque in. Egestas egestas fringilla
phasellus faucibus scelerisque eleifend. Sagittis
orci a scelerisque purus semper eget duis. Nulla
pharetra diam sit amet nisl suscipit. Sed
adipiscing diam donec adipiscing tristique
risus nec feugiat in. Fusce ut placerat orci
nulla. Pharetra vel turpis nunc eget lorem
dolor. Tristique senectus et netus et malesuada.

But menu linebreaking like (-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-) is the worst, a terminal with the same width would see:

Code: Select all

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-=-=-=-=-=-=-=-

I keep doing it myself =\ but eventually I'd like to replace it with something else.

The issue expands on any of our ascii art elements, including MOTD. In fact MOTD is the worst: it displays colors BEFORE client identified they support colors. Try to launch your terminal in vt100 mode and look at this:

I'm not sure how urgent is this particular issue issue, but it needs resolving.

[ilmarinen]

Marking it as a nope because we suck.

[ilmarinen]

I found this https://www.gnu.org/software/indent/

Vim users (like Uriel) can just use |indent -kr -nut and bind it to some-key.

-kr enable k&r standard switches and -nut enables spaces instead of tabs (because in SG codebase spaces won, in outside world c-mode uses mostly tabs).

I actually switched to it for sg by default in emacs too, since it is less agressive than ato-indent-mode. It seems to be slightly confused by mappings and array definitions, but nothing too criminal.

That binds it to S-TAB cord:

Code: Select all

(eval-after-load 'cc-mode
  '(progn
     (define-key c-mode-map (kbd "<backtab>") 'my/call-indent)))
(defun my/call-indent (&optional b e)
  "Call external indent."
  (interactive "r")
  (shell-command-on-region b e "indent -kr -l0 -bad -bap -nut"  t t "*Shell Error Output*"))

[ilmarinen]

Continuing with autoformatting tools, uncrustify seems to be able to handle LPC arrays and mappings.

[ilmarinen]

And that would be my uncrustify config to loosely reflect k&r style.

[garrett]

... If we were really awesome, we'd write an uncrustify program like Black in LPC and be done with it.

[ilmarinen]

... If we were really awesome, we'd write an uncrustify program like Black in LPC and be done with it.

Just imagine
Liche uncristifies her code -> causes mud freezes.
Sometimes external tools are better

[nienne]

Scuze me. My code is quite tidy tyvm. I've been the one on multiple accounts over the years streamlining old &/or messy stuff I find!

I may not know these fancy standards, but I'm more than OCD enough to be tidy.

Blame your mud freezes on someone else

[nienne]

Of course, if you're talking about uncrustifying the LICHE herself that's an entirely different ballgame and I plead the fifth.