<li>Opening braces go on the same line as the if/for/while statement.
For example:
<pre>
- if (condition) {
- foo;
- } else {
- bar;
- }
+if (condition) {
+ foo;
+} else {
+ bar;
+}
</pre>
-<li>Put a space before/after operators. For example, <tt>a = b + c;</tt>
-and not <tt>a=b+c;</tt>
+<li>Put a space before/after operators. For example, <code>a = b + c;</code>
+and not <code>a=b+c;</code>
<li>This GNU indent command generally does the right thing for formatting:
<pre>
- indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
+indent -br -i3 -npcs --no-tabs infile.c -o outfile.c
</pre>
<li>
<p>Use comments wherever you think it would be helpful for other developers.
Several specific cases and style examples follow. Note that we roughly
-follow <a href="https://www.stack.nl/~dimitri/doxygen/">Doxygen</a> conventions.
+follow <a href="http://www.doxygen.nl">Doxygen</a> conventions.
</p>
Single-line comments:
<pre>
- /* null-out pointer to prevent dangling reference below */
- bufferObj = NULL;
+/* null-out pointer to prevent dangling reference below */
+bufferObj = NULL;
</pre>
Or,
<pre>
- bufferObj = NULL; /* prevent dangling reference below */
+bufferObj = NULL; /* prevent dangling reference below */
</pre>
Multi-line comment:
<pre>
- /* If this is a new buffer object id, or one which was generated but
- * never used before, allocate a buffer object now.
- */
+/* If this is a new buffer object id, or one which was generated but
+ * never used before, allocate a buffer object now.
+ */
</pre>
We try to quote the OpenGL specification where prudent:
<pre>
- /* Page 38 of the PDF of the OpenGL ES 3.0 spec says:
- *
- * "An INVALID_OPERATION error is generated for any of the following
- * conditions:
- *
- * * <length> is zero."
- *
- * Additionally, page 94 of the PDF of the OpenGL 4.5 core spec
- * (30.10.2014) also says this, so it's no longer allowed for desktop GL,
- * either.
- */
+/* Page 38 of the PDF of the OpenGL ES 3.0 spec says:
+ *
+ * "An INVALID_OPERATION error is generated for any of the following
+ * conditions:
+ *
+ * * <length> is zero."
+ *
+ * Additionally, page 94 of the PDF of the OpenGL 4.5 core spec
+ * (30.10.2014) also says this, so it's no longer allowed for desktop GL,
+ * either.
+ */
</pre>
Function comment example:
<pre>
- /**
- * Create and initialize a new buffer object. Called via the
- * ctx->Driver.CreateObject() driver callback function.
- * \param name integer name of the object
- * \param type one of GL_FOO, GL_BAR, etc.
- * \return pointer to new object or NULL if error
- */
- struct gl_object *
- _mesa_create_object(GLuint name, GLenum type)
- {
- /* function body */
- }
+/**
+ * Create and initialize a new buffer object. Called via the
+ * ctx->Driver.CreateObject() driver callback function.
+ * \param name integer name of the object
+ * \param type one of GL_FOO, GL_BAR, etc.
+ * \return pointer to new object or NULL if error
+ */
+struct gl_object *
+_mesa_create_object(GLuint name, GLenum type)
+{
+ /* function body */
+}
</pre>
<li>Put the function return type and qualifiers on one line and the function
<li>Function names follow various conventions depending on the type of function:
<pre>
- glFooBar() - a public GL entry point (in glapi_dispatch.c)
- _mesa_FooBar() - the internal immediate mode function
- save_FooBar() - retained mode (display list) function in dlist.c
- foo_bar() - a static (private) function
- _mesa_foo_bar() - an internal non-static Mesa function
+glFooBar() - a public GL entry point (in glapi_dispatch.c)
+_mesa_FooBar() - the internal immediate mode function
+save_FooBar() - retained mode (display list) function in dlist.c
+foo_bar() - a static (private) function
+_mesa_foo_bar() - an internal non-static Mesa function
</pre>
-<li>Constants, macros and enum names are ALL_UPPERCASE, with _ between
-words.
-<li>Mesa usually uses camel case for local variables (Ex: "localVarname")
-while gallium typically uses underscores (Ex: "local_var_name").
+<li>Constants, macros and enum names are <code>ALL_UPPERCASE</code>, with _
+between words.
+<li>Mesa usually uses camel case for local variables (Ex:
+<code>localVarname</code>) while gallium typically uses underscores (Ex:
+<code>local_var_name</code>).
<li>Global variables are almost never used because Mesa should be thread-safe.
<li>Booleans. Places that are not directly visible to the GL API
-should prefer the use of <tt>bool</tt>, <tt>true</tt>, and
-<tt>false</tt> over <tt>GLboolean</tt>, <tt>GL_TRUE</tt>, and
-<tt>GL_FALSE</tt>. In C code, this may mean that
-<tt>#include <stdbool.h></tt> needs to be added. The
-<tt>try_emit_</tt>* methods in src/mesa/program/ir_to_mesa.cpp and
-src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as examples.
+should prefer the use of <code>bool</code>, <code>true</code>, and
+<code>false</code> over <code>GLboolean</code>, <code>GL_TRUE</code>, and
+<code>GL_FALSE</code>. In C code, this may mean that
+<code>#include <stdbool.h></code> needs to be added. The
+<code>try_emit_*</code> methods in <code>src/mesa/program/ir_to_mesa.cpp</code>
+and <code>src/mesa/state_tracker/st_glsl_to_tgsi.cpp</code> can serve as
+examples.
</ul>
projects / mesa.git / blobdiff