C++ Style Guide - Revision history

Kman: /* Namespaces */

2018-08-02T14:59:38Z

Namespaces

Kman: /* Namespaces */

2018-08-02T14:59:07Z

Namespaces

Kman: /* Development Environment */

2018-08-02T14:57:01Z

Development Environment

Kman at 15:26, 30 April 2018

2018-04-30T15:26:25Z

Kamal: /* Development Environment */

2018-02-23T01:55:10Z

Development Environment

Kman: /* Directory Structure */

2018-02-15T16:14:45Z

Directory Structure

Kman: /* Directory Structure */

2018-02-15T14:55:31Z

Directory Structure

Kman at 14:54, 15 February 2018

2018-02-15T14:54:44Z

Kman: /* Variable Declarations */

2018-02-12T22:54:57Z

Variable Declarations

Kman: /* Syntax */

2018-02-12T22:54:41Z

Syntax

@@ Line 175: / Line 175: @@
 </syntaxhighlight>
-One situation where nested namespaces are welcome and encouraged are for implementation details that do not form part of the namespace's public interface. These definitions are put in a nested namespace called ''details'' and go into a file of their own whose name contains the suffix ''details''. For example if the ''cpp_chat_server.hpp'' contains implementation details, then they should be included in the file ''cpp_chat_server_details.hpp'' and the definitions should go into the namespace ''cpp_chat::details''.
+One situation where nested namespaces are welcome and encouraged are for implementation details that do not form part of the namespace's public interface. These definitions are put in a nested namespace called ''Details'' and go into a file of their own whose name contains the suffix ''details''. For example if the ''cpp_chat_server.hpp'' contains implementation details, then they should be included in the file ''cpp_chat_server_details.hpp'' and the definitions should go into the namespace ''CppChat::Details''.
 =Layout=

@@ Line 158: / Line 158: @@
 <syntaxhighlight lang=c++ line=line>
-namespace cpp_chat {
+namespace CppChat {
-namespace sub_chat_a {
+namespace SubChatA {
    ...
+}
-namespace sub_chat_b {
+namespace SubChatB {
-namespace sub_sub_chat_a {
+namespace SubSubChatA {
    ...
+}
@@ Line 170: / Line 170: @@
+}
-namespace cpp_chat_extra {
+namespace CppChatExtra {
    ...
+}

@@ Line 14: / Line 14: @@
 =Development Environment=
-The two primary development environments supported by Spire projects are Ubuntu Server 18.02 LTS and Windows 10. On POSIX systems the compiler of choice is g++ 7.3 and on Windows 10 it's Microsoft Visual Studio 2017 15.6. In order to support these two platforms, CMake is used to produce the appropriate project/make files for each platform.
+The two primary development environments supported by Spire projects are Ubuntu Server 18.04 LTS and Windows 10. On POSIX systems the compiler of choice is g++ 7.3 and on Windows 10 it's Microsoft Visual Studio 2017 15.7.5. In order to support these two platforms, CMake is used to produce the appropriate project/make files for each platform.
 For source control, git is used and projects are to be hosted on [https://github.com/spiretrading Spire Trading's Github page].

@@ Line 14: / Line 14: @@
 =Development Environment=
-The two primary development environments supported by Spire projects are Ubuntu Server 16.04 LTS and Windows 10. On Unix like systems the compiler of choice is g++ 5.4 and on Windows 10 it's Microsoft Visual Studio 2017 15.5.7. In order to support these two platforms, CMake is used to produce the appropriate project/make files for each platform.
+The two primary development environments supported by Spire projects are Ubuntu Server 18.02 LTS and Windows 10. On POSIX systems the compiler of choice is g++ 7.3 and on Windows 10 it's Microsoft Visual Studio 2017 15.6. In order to support these two platforms, CMake is used to produce the appropriate project/make files for each platform.
 For source control, git is used and projects are to be hosted on [https://github.com/spiretrading Spire Trading's Github page].

@@ Line 14: / Line 14: @@
 =Development Environment=
-The two primary development environments supported by Spire projects are Ubuntu Server 16.04 LTS and Windows 10. On Unix like systems the compiler of choice is g++ 5.4 and on Windows 10 it's Microsoft Visual Studio 2017 15.5.5. In order to support these two platforms, CMake is used to produce the appropriate project/make files for each platform.
+The two primary development environments supported by Spire projects are Ubuntu Server 16.04 LTS and Windows 10. On Unix like systems the compiler of choice is g++ 5.4 and on Windows 10 it's Microsoft Visual Studio 2017 15.5.7. In order to support these two platforms, CMake is used to produce the appropriate project/make files for each platform.
 For source control, git is used and projects are to be hosted on [https://github.com/spiretrading Spire Trading's Github page].

@@ Line 38: / Line 38: @@
 Finally there is a top-level ''build'' directory for the project as a whole which produces all artifacts by recursively calling each artifact's individual build scripts. Additionally the top-level build directory also includes a ''setup'' script which downloads all third party dependencies. Some projects may also opt to include an ''install'' script which sets up a suitable development environment, and other scripts for continuous builds, deployment and testing.
-Assuming a project named chat consisting of applications chat_server and chat_client sharing code common to both applications, the following directory structure should be used:
+Assuming a project named tic_tac_toe consisting of applications tic_tac_toe_console and tic_tac_toe_ui sharing code common to both applications, the following directory structure should be used:
 <pre>
-chat_project                       # Root level directory.
+tic_tac_toe                        # Root level directory.
    \applications                    # Contains all applications.
-     \chat_server                   # Contains the chat server application.
+     \tic_tac_toe_console           # Contains the source for a console application.
-       \build                       # Files/scripts used to build the chat server.
+       \build                       # Files/scripts used to build the console tic-tac-toe game.
          \config                    # Contains all CMake build files.
            CMakeLists.txt           # The CMake config file for the overall application.
-           \chat_server             # Contains CMake build files for the main executable.
+           \tic_tac_toe_console     # Contains CMake build files for the main executable.
              \CMakeLists.txt        # The CMake config file for the executable.
          \posix                     # Contains scripts to build on POSIX systems.
@@ Line 60: / Line 60: @@
            \version.bat             # Script that produces the VERSION stamped header file.
        \source                      # Contains the C++ source files.
-         \chat_server               # Contains the file defining the main function.
+         \tic_tac_toe_console       # Contains the file defining the main function.
            \main.cpp                # Defines the main function.
-         \source_dir_a              # Contains additional source files specific the the server.
+         \source_dir_a              # Contains additional source files specific the console.
            \source_a.cpp            # C++ source code files.
            \source_b.cpp
            \source_c.cpp
-         \source_dir_b              # Contains additional source files specific the the server.
+         \source_dir_b              # Contains additional source files specific the console.
            \source_d.cpp
            \source_e.cpp
            \source_f.cpp
-     \chat_client                   # Contains the chat client application.
+     \tic_tac_toe_ui                # Contains a GUI version of tic-tac-toe.
-       \...                         # The structure is similar to the server application.
+       \...                         # The structure is similar to the console application.
    \build                           # Contains build scripts to build the entire project.
      \posix                         # Contains scripts to build on POSIX systems.
@@ Line 99: / Line 99: @@
          \set_env.bat               # Script defining the environment variables.
      \include                       # Contains the library header files (.hpp)
-       \chat_project                # Same as above.
+       \tic_tac_toe
-         \chat_project              # Contains the top-most generic library header files.
+         \tic_tac_toe               # Contains the top-most generic library header files.
-           \chat_project.hpp        # Header file containing generic forward declarations.
+           \tic_tac_toe.hpp         # Header file containing generic forward declarations.
          \dir_a                     # Contains header files for library component A.
            \a.hpp                   # Header file containing forward declarations for component A.
@@ Line 113: / Line 113: @@
            \b_header_3.hpp
      \source                        # Contains the library source files (.cpp)
-       \chat_project                # Dummy directory for the overall library.
+       \tic_tac_toe                 # Dummy directory for the overall library.
          \dummy.cpp                 # Dummy source code file.
        \dir_a                       # Dummy directory for library component A.
@@ Line 131: / Line 131: @@
 </pre>
-An example of the above directory structure containing a basic skeletal implementation of all files can be found here: https://github.com/spiretrading/chat_project
+An example of the above directory structure containing a basic skeletal implementation of all files can be found here: https://github.com/spiretrading/tic_tac_toe
 =Header File Structure=

@@ Line 34: / Line 34: @@
 A project is broken down into one library component and one or more application components. These components are referred to as ''artifacts''. The library is written in a [https://en.wikipedia.org/wiki/Header-only header-only fashion], that is the implementation is provided directly in the header file rather than a separate .cpp source file. This allows for such libraries to easily be incorporated into other projects without the need for complex build configurations. Applications often use a mix of header only files and source files.
-The applications go into their own ''applications'' directory and the libraries into the ''library'' directory. Within each artifact is a ''build'' directory containing the build scripts and CMake files needed to build that artifact. Scripts for POSIX systems are found in the ''make'' sub-directory and Windows build files are within the ''windows'' sub-directory. The build scripts specified are ''run_cmake'' to produce the platform specific build files (make files for POSIX and VS solutions for Windows), ''version'' to produce a header file that contains the version of the artifact produced and the ''build'' script which produces the artifact. In order to build an artifact, one first produces the build files for their platform by running the ''run_cmake'' script, and then they can run the ''build'' script afterwards to produce the artifact.
+The applications go into their own ''applications'' directory and the libraries into the ''library'' directory. Within each artifact is a ''build'' directory containing the build scripts and CMake files needed to build that artifact. Scripts for POSIX systems are found in the ''posix'' sub-directory and Windows build files are within the ''windows'' sub-directory. The build scripts specified are ''run_cmake'' to produce the platform specific build files (make files for POSIX and VS solutions for Windows), ''version'' to produce a header file that contains the version of the artifact produced and the ''build'' script which produces the artifact. In order to build an artifact, one first produces the build files for their platform by running the ''run_cmake'' script, and then they can run the ''build'' script afterwards to produce the artifact.
 Finally there is a top-level ''build'' directory for the project as a whole which produces all artifacts by recursively calling each artifact's individual build scripts. Additionally the top-level build directory also includes a ''setup'' script which downloads all third party dependencies. Some projects may also opt to include an ''install'' script which sets up a suitable development environment, and other scripts for continuous builds, deployment and testing.
@@ Line 49: / Line 49: @@
            \chat_server             # Contains CMake build files for the main executable.
              \CMakeLists.txt        # The CMake config file for the executable.
-         \make                      # Contains scripts to build on POSIX systems.
+         \posix                     # Contains scripts to build on POSIX systems.
            \build.sh                # Script used to build the application.
            \run_cmake.sh            # Script used to produce the make/build files.

@@ Line 73: / Line 73: @@
        \...                         # The structure is similar to the server application.
    \build                           # Contains build scripts to build the entire project.
-     \make                          # Contains scripts to build on POSIX systems.
+     \posix                         # Contains scripts to build on POSIX systems.
        \build.sh                    # Builds all libraries and applications.
        \local_build.sh              # A helper script containing common build functions.
@@ Line 90: / Line 90: @@
          \dir_b                     # Contains CMake build files for library component B.
            \CMakeLists.txt          # The CMake config file to build component B and unit tests.
-       \make                        # Contains scripts to build on POSIX systems.
+       \posix                       # Contains scripts to build on POSIX systems.
          \build.sh                  # Script used to build the library.
          \run_cmake.sh              # Script used to produce make/build files.

@@ Line 341: / Line 341: @@
 <syntaxhighlight lang=c++ line=line>
-auto value = [] {
+auto value = [&] {
    if(condition) {
      return 123;

@@ Line 312: / Line 312: @@
 ==Function Definitions==
-Functions declared and defined in header files should be done as follows:
+Functions declared and defined in header files are formatted as follows:
 <syntaxhighlight lang=c++ line=line>
 inline int f() {
@@ Line 318: / Line 318: @@
    return 123;
+}
 </syntaxhighlight>
-That is they should be declared as inline unless they are function templates.
+For complex initialization of values, use an [https://en.wikipedia.org/wiki/Immediately-invoked_function_expression immediately invoked lambda expression] as follows:
 =Additional References=