Other Coding Rules

From OpenMW Wiki
Revision as of 22:36, 13 July 2020 by Ptmikheev (talk | contribs) (→‎Other Pieces of Advice)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Namespaces[edit]

We prefer fully qualified names (e.g. std::cout).

Using directives (e.g. "using namespace std") are not welcome. Using directives in headers will result in the code being rejected.

Using declarations (e.g. "using std::cout") are tolerated, but should be used only in the innermost possible scope (i.e. usually function scope). Fully qualified names are still preferred.

Do not declare any names in the global namespace (the only exception to this rule is the file which contains the main() function of an executable).

Other Pieces of Advice[edit]

  • Prefer C++ means over C means. In particular:
    • Do not use the preprocessor for purposes other than conditional compiling (this includes include guards)
    • Use C++ streams instead of C I/O
    • Use new/delete instead of malloc/free (but usage of new/delete should also be limited, see below)
  • Prefer STL-container over raw arrays and new[]/delete[].
  • Use new/delete only when necessary. Prefer automatic storage duration.
  • Throw exceptions instead of retuning error codes.
  • When returning a pointer, don't return a 0-pointer in case of an error (returning a 0-pointer is still valid, if it does not represent an error situation).
  • Remember the Rule of Three.
  • Use osg means where it is applicable. In particular:
    • Use osg::PI instead of M_PI;
    • Use osg::Vec3d instead of double[3];
    • Consider to use osg::clampBetween(v, 0.f, 1.f) instead of std::max(0.f, std::min(v, 1.f)).