Mercurial > audlegacy
annotate HACKING @ 4415:2c3390afe10e
Added a coding guideline document.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Mon, 31 Mar 2008 17:21:21 +0300 |
parents | |
children | ac8d871b6075 f922499e69bc |
rev | line source |
---|---|
4415
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
1 Hacking / coding guide for Audacious and Audacious-plugins |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
2 ========================================================== |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
3 (C) Copyright 2008 Audacious Development Team |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
4 Written by Matti 'ccr' Hämäläinen <ccr@tnsp.org> |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
5 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
6 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
7 Premeable |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
8 ========= |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
9 This document describes the guidelines for people who wish to work on |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
10 improving or cleaning up Audacious media player, or any of the plugins |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
11 we distribute in the plugins package. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
12 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
13 It is probably obvious to anyone who has taken a look into the depths |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
14 of Audacious source, that many of these guidelines are not actually |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
15 followed currently in all places, if at all. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
16 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
17 In fact, the purpose of this document is to act as a target to aim at, |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
18 when noticing and cleaning up uncompliant code.. or writing new code. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
19 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
20 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
21 Coding guidelines |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
22 ================= |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
23 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
24 - We use Glib for portability. This means that we have sized integer types |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
25 like gint{16,32,64}, etc. and shorthand types like guint and guchar |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
26 provided, so please do use them. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
27 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
28 Arguably C99 provides inttypes.h with similar types, but C99 support |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
29 may not be complete on all platforms, it is both safer and more uniform |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
30 to use glib types. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
31 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
32 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
33 - Use other glib functionality, especially string handling like: |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
34 * g_snprintf(), g_strdup_printf(), g_strdup() ... |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
35 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
36 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
37 - However, avoid following Glib things: |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
38 * GString - Useless in most cases compared to normal 'C' string functions |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
39 and introduces conversions back and forth. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
40 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
41 * GList - GList is slow, either use GQueue or libmowgli lists. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
42 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
43 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
44 - Be sure to know when you are handling UTF-8 or something else! Glib offers |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
45 special g_ascii_*() functions for certain operations that you might need |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
46 when handling non-unicode strings. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
47 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
48 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
49 - When reading data from files, it's usually a BIG mistake to read structs |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
50 directly from the stream! This is not portable, as C does not guarantee |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
51 a struct not to have alignment padding (unless the struct is "packed", |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
52 but see below.) In effect sizeof(struct) on some platform may not be |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
53 equal to some other platform. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
54 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
55 Some clever people might think that making struct "packed" via the |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
56 C packed qualifier would be a solution, but this will |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
57 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
58 What you SHOULD do is read individual members of the struct one by one |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
59 from the stream. This may sound bothersome, but by doing so, your code |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
60 will be portable. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
61 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
62 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
63 - Always use Glib sized types for reading integer data from file streams. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
64 Using plain C types (like 'long int' for example) is not wise, because |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
65 they may be of different size on different platforms depending on the |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
66 platform ABI. For example, on some 64-bit platforms, 'long int' is |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
67 64 bits, while on 32-bit platforms it is 32 bits. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
68 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
69 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
70 - Audacious core provides some helper functions for reading endian-dependant |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
71 integers from VFS streams (aud_vfs_fget_{le,be}{16,32,64}), see vfs.h and |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
72 documentation for more information. |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
73 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
74 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
75 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
76 Additional style guidelines |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
77 =========================== |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
78 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
79 - Indentation: Use the same indentation style (also spaces vs. tabs) |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
80 as the file you are editing. In new files/code, use indentation of |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
81 4 spaces (no tabs). |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
82 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
83 - Whitespace usage in code: |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
84 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
85 a = 1; |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
86 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
87 if (b == d && !strcmp(a, c)) ... |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
88 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
89 - Blocks: |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
90 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
91 while (...) { |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
92 do_something(...) |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
93 } |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
94 |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
95 if (...) { |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
96 } else { |
2c3390afe10e
Added a coding guideline document.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
97 } |