The conventions here should be applied to all new code, and with common sense when modifying existing code. For example, renaming a widely used, existing function to follow these conventions may not be justified unless the whole code is getting a rework.
Currently, this only documents the present state of the code: no particular attempt has been made to consolidate the naming.
C++ source files have a
.cppextension, C source files
.c, and headers for both use
For source file
file.cpp, declarations that are visible outside the source file should go into a correspondingly named header:
file.h. Some code may deviate from this rule to improve readability and/or usability of the API, but this should then be clearly documented.
There can also be a
file_impl.hfile that declares classes or functions that are not accessible outside the module. If the whole file only declares symbols internal to the module, then the
_impl.hsuffix is omitted.
In most cases, declarations that are not used outside a single source file are in the source file.
-doc.hfor files that contain only Doxygen documentation for some module or such, for cases where there is no natural single header for putting the documentation.
For C++ files, prefer naming the file the same as the (main) class it contains. Currently all file names are all-lowercase, even though class names contain capital letters. It is OK to use commonly known abbreviations, and/or omit the name of the containing directory if that would cause unnecessary repetition (e.g., as a common prefix to every file name in the directory) and the remaining part of the name is unique enough.
Avoid having multiple files with the same name in different places within the same library. In addition to making things harder to find, C++ source files with the same name can cause obscure problems with some compilers. Currently, unit tests are an exception to the rule (there is only one particular compiler that had problems with this, and a workaround is possible if/when that starts to affect more than a few of the test files).
Common guidelines for C and C++ code#
Preprocessor macros should be all upper-case. Do not use leading underscores, as all such names are reserved according to the C/C++ standard.
Name include guards like
Avoid abbreviations that are not obvious to a general reader.
If you use acronyms (e.g., PME, DD) in names, follow the Microsoft policy on casing: two letters is uppercase (DD), three or more is lowercase (Pme). If the first letter would be lowercase in the context where it is used (e.g., at the beginning of a function name, or anywhere in a C function name), it is clearest to use all-lowercase acronym.
All function and variable names are lowercase, with underscores as word separators where needed for clarity.
All functions that are part of the public API should start with
gmx_. Preferably, other functions should as well. Some parts of the code use a
_gmx_prefix for internal functions, but strictly speaking, these are reserved names, so, e.g., a trailing underscore would be better.
Old C code and changes to it can still use the hungarian notation for booleans and enumerated variable names, as well as enum values, where they are prefixed with
erespectively, or you can gradually move to the C++ practice below. Whatever you choose, avoid complex abbreviations.
Use CamelCase for all names. Start types (such as classes, structs, typedefs and enum values) with a capital letter, other names (functions, variables) with a lowercase letter. You may use an all-lowercase name with underscores if your class closely resembles an external construct (e.g., a standard library construct) named that way.
C++ interfaces are named with an
Iprefix, such as in ICommandLineModule. This keeps interfaces identifiable, without introducing too much clutter (as the interface is typically used quite widely, spelling out
Interfacewould make many of the names unnecessarily long).
Abstract base classes are typically named with an
Member variables are named with a trailing underscore.
Accessors for a variable
Global variables are named with a
Global and file-static variables are named with a
Static class and function variables are named with an
constexprfile, class, or function members are named with a
Global constants are often named with a
If the main responsibility of a file is to implement a particular class, then the name of the file should match that class, except for possible abbreviations to avoid repetition in file names (e.g., if all classes within a module start with the module name, omitting or abbreviating the module name is OK). Currently, all source file names are lowercase, but this casing difference should be the only difference.
For new C++ code, avoid using the hungarian notation that is a descendant from the C code (i.e., the practice of using a
bprefix for boolean variables and an
eprefix for enumerated variables and/or values). Instead, make the names long with a good description of what they control, typically including a verb for boolean variables, like
Prefer class enums over regular ones, so that unexpected conversions to int do not happen.
Name functions to convert class enum values to strings as
When using a non-class enum, prefer to include the name of the enumeration type as a base in the name of enum values, e.g.,
HelpOutputFormat_Console, in particular for settings exposed to other modules.
Prefer to use enumerated types and values instead of booleans as control parameters to functions. It is reasonably easy to understand what the argument
HelpOutputFormat_Consoleis controlling, while it is almost impossible to decipher
TRUEin the same place without checking the documentation for the role of the parameter.
The rationale for the trailing underscore and the global/static prefixes is that it is immediately clear whether a variable referenced in a method is local to the function or has wider scope, improving the readability of the code.
Code for GPUs#
Rationale: on GPUs, using the right memory space is often performance critical.
In CUDA device code
cm_prefixes are used for shared, global and constant memory. The absence of a prefix indicates register space. Same prefixes are used in OpenCL code, where
sm_indicates local memory and no prefixes are added to variables in private address space.
Data transferred to and from host has to live in both CPU and GPU memory spaces. Therefore it is typical to have a pointer or container (in CUDA), or memory buffer (in OpenCL) in host memory that has a device-based counterpart. To easily distinguish these, the variables names for such objects are prefixed
d_and have identical names otherwise. Example:
In all other cases, pointers to host memory are not required to have the prefix
h_(even in parts of the host code, where both host and device pointers are present). The device pointers should always have the prefix
In case GPU kernel arguments are combined into a structure, it is preferred that all device memory pointers within the structure have the prefix
kernelArgs.d_datais preferred to
d_kernelArgs.data, whereas both
kernelArgs.dataare not acceptable).
Note that the same pointer can have the prefix
d_in the host code, and
gm_in the device code. For example, if
d_datais passed to the kernel as an argument, it should be aliased to
gm_datain the kernel arguments list. In case a device pointer is a field of a passed structure, it can be used directly or aliased to a pointer with
kernelArgs.d_datacan be used as is or aliased to
gm_datainside the kernel).
Avoid using uninformative names for CUDA warp, thread, block indexes and their OpenCL analogs (i.e.
threadIndexis preferred to
Test fixtures (the first parameter to
TEST_F) are named with a
Classes meant as base classes for test fixtures (or as names to be typedefed to be fixtures) are named with a
The CTest test is named with CamelCase, ending with
The test binary is named with the name of the module and a