c.sexchat/share/doc/hacking.md

37 lines
1018 B
Markdown
Raw Normal View History

2012-10-27 19:31:51 +02:00
# HexChat Hacking Guidelines
Just some tips if you're going to help with HexChat code (patches etc):
2013-05-13 13:38:01 +02:00
* Use tabs, not spaces, to indent and align code.
2012-10-27 19:31:51 +02:00
2013-05-13 13:38:01 +02:00
* Use a tab size of 4 (most editors will let you choose this).
Type :set ts=4 in vim/gvim.
2012-10-27 19:31:51 +02:00
2012-10-28 09:55:45 +01:00
* Try to stick to the same consistant coding style (vertically aligned braces, a space after if, while, functions etc.):
2012-10-27 19:31:51 +02:00
2013-06-23 12:29:26 +02:00
```C
void
routine (void)
{
if (function (a, b, c))
2012-10-27 19:31:51 +02:00
{
2013-06-23 12:29:26 +02:00
x = a + 1;
}
}
```
2012-10-27 19:31:51 +02:00
* Don't use "//" C++ style comments, some compilers don't like them.
* When opening a file with Unix level functions (open, read/write, close)
as opposed to the C level functions (fopen, fwrite/fread, fclose), use
2013-06-27 19:53:29 +02:00
the OFLAGS macro. This makes sure it'll work on Win32 as well as Unix e.g.:
2012-10-27 19:31:51 +02:00
<pre>fh = open ("file", OFLAGS | O_RDONLY);</pre>
* Use closesocket() for sockets, and close() for normal files.
* Don't read() from sockets, use recv() instead.
2013-06-23 12:29:26 +02:00
* Patches are only accepted as a Github Pull request: https://help.github.com/articles/using-pull-requests
2012-10-27 19:31:51 +02:00