programming_style.md

   1 # Programming Style/Code Formatting
   2
   3 Probably in majority of cases a [programming language](programming_language.md) lets the programmer choose the aesthetic style in which to write the code (just like a writer may format his text in visually different ways without changing the meaning of it) -- one has a choice in naming variables, indentation and aligning commands, inserting [comments](comment.md) and so on. This gives rise to various styles -- typically a programmer will have his own preferred style, kind of like handwriting, but once he works in a team, some compromise has to be found to which everyone must conform so as to keep the code nice, consistent and [readable](readability.md) by everyone. Some project, e.g. [Linux](linux.md), have evolved quite good, tested and de facto standardized styles, so instead of inventing a custom style (which may not be as easy as it sounds) one may choose to adopt some of the existing styles. While this is more of a surface-level part of programming, it is still quite important and thinking about it may go very deep, it is not to be underestimated.
   4
   5 There exist automatic code formatters, they are often called **code beautifiers**. But not everything can be automatized, for example a program will hardly comment your code, or inserting empty spaces to separate logically related parts of a sequential code is also something that human like intelligence is needed for.
   6
   7 ## Recommended LRS C Programming Style/Formatting
   8
   9 Here we propose a programming style and C code formatting you may use in your programs. { It's basically a style I personally adopted and fine-tuned over many years of my programming. ~drummyfish } Remember that nothing is set in stone (except that you mustn't use tabs), the most important thing is usually to be consistent within a single project and to actually think about why you're doing things the way you're doing them. Keeping to the standard set here will gain you advantages such as increased readability for others already familiar with the same style and avoiding running into traps set by short-sighted decisions e.g. regarding identifiers. Try to think from the point of view of a programmer who gets just your source code without any way to communicate with you, make his life as easy as possible. Also suppose he's reading your code on a calculator. The LRS style/formatting rules follow:
  10
  11 - **Respect the [LRS](lrs.md) design principles** ([KISS](kiss.md), no [OOP](oop.md), avoid dependencies such as [stdlib](stdlib.md) etc.).
  12 - **Indentation: use two spaces, NEVER use [tabs](tab.md)**. Why? Tabs are ugly, tricky (look the same as spaces) non-standard behaving characters (behavior is dependent on editor and settings, some processors will silently convert tabs and spaces, copy-paste may do so also etc.), they don't carry over to some platforms (especially paper), some very simple platforms may not even support them; your source will contain spaces either way, no need to insert additional blank character.
  13 - **Limit source code width to 80** columns or similar value. If the line is a single command, e.g. a function call or expression, that would be too long, just break it and somewhere before the limit and put the rest on the next line, possibly indenting the below lines one level further. Keep in mind the source may be edited on computers with small screens (like old [thinkpads](thinkpad.md), especially within context of LRS) with a screen split vertically to two or more columns.
  14 - Write **opening and closing curly brackets on their own lines, in the same columns**, e.g.:
  15
  16 ```
  17 if (a == b)
  18 {
  19   doSomething();
  20   doSomething2();
  21 }
  22 else
  23 {
  24   doSomethingElse();
  25   doSomethingElse2();
  26 }
  27 ```
  28
  29 - **Omit curly brackets if you can** (e.g. with a single command in the block). However write them where not doing so is likely to cause confusion or syntax errors.
  30 - **Use normal brackets to make precedence and intention clearer** even if they would be unnecessary, don't flex by writing an expression with confusing precedence that saves 4 text characters. For example it may be better to write `(a && b) || c` rather than `a && b || c`.
  31 - **identifiers/names**:
  32   - **Use `camelCase` for variables and functions** (e.g. `myVariable`). Global and big-scope variables should have a greatly descriptive, self-documenting name, even if long (e.g. `getTicksSinceStart`, `countryAreaKMSquared`), local/short-scope identifiers can be shorter (e.g. `argBackup` within a single function), even just one letter (e.g. `i` within a single loop).
  33   - **Use `CapitalCamelCase` for data types** (e.g. `ImaginaryNumber`, `GameState` etc.).
  34   - **Use `ALL_CAPS_SNAKE_CASE` for macros and constants** (e.g. `PI`, `MIN`, `LOG_ERROR`, ...).
  35   - It is advised that for your project you come up with a **three letter namespace prefix** that will come in front of your global identifiers. (E.g. [small3dlib](small3dlib.md) uses the prefix `S3L_`, [SDL](sdl.md) uses `SDL` etc.). If you choose a prefix `XYZ_`, prepend it to all global identifiers, it will prevent name clashes and help readability, e.g. when writing a renderer you will export identifiers such as `XYZ_init`, `XYZ_draw`, `XYZ_setPixel`, `XYZ_Model3D` etc. Do NOT use the prefix in local variables (inside functions, loops etc.).
  36   - **Prefix private global identifiers with `_`**, e.g. `_tmpPointerBackup`; with the above mentioned namespace prefix this will look e.g. like this: `_XYZ_tmpPointerBackup`.
  37 - **Use spaces** to make code more readable, so e.g. `int x = 10, y = 20;` instead of `int x=10,y=20;`, write space between `if` and its condition etc.
  38 - **Use verbs for [functions](function.md), nouns for variables** and keep consistency, e.g. a function should be named `getTimeMS` while a variable will be named `timeMS`. Functions are to be formatted like this:
  39
  40 ```
  41 void doSomethingCool(int a, int b, int c)
  42 {
  43   // ...
  44 }
  45 ```
  46
  47 - **Name from general to specific**, e.g. `getCountryTimezone` and `getCountryCapital` instead of `getTimeZoneOfCountry`, `getCapitalOfCountry` etc. This helps with code completion systems. It's not always exactly clear, you may also decide to go for `countryGetTimezone` etc., just keep it consistent.
  48 - **Switch** shall always have the *default* label. The statements may be formatted e.g. like this:
  49
  50 ```
  51 switch (myVariable)
  52 {
  53   case 0:
  54     doSomething();
  55     break;
  56
  57   case 1:
  58     doSomethingElse();
  59     break;
  60
  61   case 2:
  62   {
  63     int a = x + y;
  64     doSomethingCool(a);
  65     break;
  66   }
  67
  68   default:
  69     break;
  70 }
  71
  72 // or even (depending on how long the sections are)
  73
  74 switch (myVariable2)
  75 {
  76   case 0: doSomething1(); break;
  77   case 1: doSomething2(); break;
  78   case 2: doSomething3(); break;
  79   case 3: doSomething4(); break;
  80   default: break;
  81 }
  82 ```
  83
  84 - **Filenames**: always use only lowercase letters (some older systems just know one case, don't confuse them), either use `camel_case.ext` or `nocase.ext`.
  85 - **Use blank lines** to logically group relevant lines of code. E.g.:
  86
  87 ```
  88 int a = x;
  89 char b = y;
  90 double q;
  91
  92 doSomething(a);
  93
  94 c += 3 * a;
  95 d -= b;
  96
  97 if (c < d)
  98   a = b;
  99 ```
 100
 101 - Each file shall have a **global [comment](comment.md)** at the top with at least: short description of the file's purpose (this is almost always missing in mainstream), short documentation, [license](license.md), the author(s) and year of creation.
 102 - **Use [comments](comment.md)** to make your code better readable and searchable with things like [grep](grep.md) (add keywords to relevant parts of code, e.g. comment `// player shoots` to code implementing player shooting etc.). **Use [doxygen](doxygen.md) style comments** if you can, it costs nothing and allows auto documentation.
 103 - **TODOs and WIPs are good**.
 104 - **Don't use [enums](enum.md)**, use `#define`s.
 105 - **Global variables are great**, use them. **Long functions are fine**. [Repeating yourself](dry.md) may also be fine if it's something like 3 lines of code and the alternative would be too complex (but things like variadic macros can usually solve even these cases, always think hard in these cases).
 106 - **Adhere to C99  or C89 standard**. It's ideal if your code is valid in both and maybe even more standards, AND in [C++](cpp.md) as well.
 107 - **Try to not create many source files**, many times your project can very well be in a single file which is the ideal case -- it will make it compile VERY fast, possibly be even better optimized (the compiler sees the whole code) and it will be easy to compile, it's basically a win-win-win-win-win-win-win scenario. Create **[header only libraries](header_only.md)** If you have multiple files, keep them in the same directory and try to have just a **[single compilation unit](single_compilation_unit.md)** (only one .c file with several .h files). Try to make files no longer than 10k lines.
 108 - **Use the LRS [version numbering](version_numbering.md) system**.
 109 - **Never use non-[ASCII](ascii.md) characters in your source code**. Just don't, there is basically never any need for it.
 110 - **Don't depend on any compiler extensions!** For maximum portability minimize [dependencies](dependency.md), i.e. don't RELY on things like GNU C extensions, POSIX extensions (things like `_POSIX_C_SOURCE`, `_XOPEN_SOURCE` etc.). You MAY use them, but always do so in a way that makes it easy to get rid of them -- for example do not use macros such as `PATH_MAX` directly, always define your own macro, e.g. `#define MYLIB_PATH_MAX PATH_MAX` and only use that -- this way you may easily switch to e.g. hardcoded limit if the macro isn't available on some system. Similarly with anything else: if your program is using a feature specific to a compiler, operating system, some extra third party standard and so on, always offer an easy way of disabling or replacing it ([preprocessor](preprocessor.md) is very good for this).
 111 - ...
 112
 113 ### Example
 114
 115 Here is a short example applying the above shown style:
 116
 117 ```
 118 TODO (for now see LRS projects like Anarch, small3dlib, SAF etc.)
 119 ```