Format all code using ClangFormat

* Add .clang-format file
* Reformat the code
* Add CI step to check that clang-format was ran
* Add README notes about ClangFormat

Author: eliasdaler

.clang-format

@@ -0,0 +1,75 @@
+Language: Cpp
+AccessModifierOffset: -4
+AlignAfterOpenBracket: true
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: InlineOnly
+AllowShortIfStatementsOnASingleLine: true
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: true
+BinPackParameters: true
+BreakBeforeBraces: Custom
+BraceWrapping:
+    AfterClass: false
+    AfterControlStatement: false
+    AfterEnum: false
+    AfterFunction: false
+    AfterNamespace: false
+    AfterStruct: false
+    AfterUnion: true
+    AfterExternBlock: true
+    BeforeCatch: false
+    BeforeElse: false
+    IndentBraces: false
+    SplitEmptyFunction: false
+    SplitEmptyRecord: false
+    SplitEmptyNamespace: false
+BreakBeforeBinaryOperators: None
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
+BreakStringLiterals: true
+ColumnLimit: 100
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+FixNamespaceComments: false
+IncludeBlocks: Preserve
+IndentCaseLabels: false
+IndentPPDirectives: None
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+PenaltyBreakBeforeFirstCallParameter: 1000
+PenaltyBreakComment: 10
+PenaltyReturnTypeOnItsOwnLine: 1000
+PointerAlignment: Left
+ReflowComments: true
+SortIncludes: true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: Cpp11
+UseTab: Never

.github/workflows/build.yml

@@ -112,6 +112,14 @@ jobs:
         submodules: recursive
         path: imgui-sfml
 
+    # Container action is only supported on Linux
+    - name: Check Clang Format
+      if: runner.os == 'Linux'
+      uses: DoozyX/[email protected]
+      with:
+        source: '.'
+        extensions: 'h,cpp'
+
     - name: Checkout SFML
       uses: actions/checkout@v2
       with:

README.md

@@ -14,6 +14,12 @@ Dependencies
 * [SFML](https://github.com/SFML/SFML) >= 2.5.0
 * [Dear ImGui](https://github.com/ocornut/imgui) >= 1.68
 
+Contributing
+-----
+
+* The code is written in C++03. See [#7](https://github.com/eliasdaler/imgui-sfml/issues/7)
+* The code should be formatted via [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html) using `.clang-format` provided in the root of this repository
+
 How-to
 ----
 
@@ -91,13 +97,12 @@ See example file [here](examples/main.cpp)
 #include "imgui.h"
 #include "imgui-SFML.h"
 
+#include <SFML/Graphics/CircleShape.hpp>
 #include <SFML/Graphics/RenderWindow.hpp>
 #include <SFML/System/Clock.hpp>
 #include <SFML/Window/Event.hpp>
-#include <SFML/Graphics/CircleShape.hpp>
 
-int main()
-{
+int main() {
     sf::RenderWindow window(sf::VideoMode(640, 480), "ImGui + SFML = <3");
     window.setFramerateLimit(60);
     ImGui::SFML::Init(window);

examples/main.cpp

@@ -1,13 +1,13 @@
-#include "imgui.h"
-#include "imgui-SFML.h"
+#include "imgui.h" // necessary for ImGui::*, imgui-SFML.h doesn't include imgui.h
 
+#include "imgui-SFML.h" // for ImGui::SFML::* functions and SFML-specific overloads
+
+#include <SFML/Graphics/CircleShape.hpp>
 #include <SFML/Graphics/RenderWindow.hpp>
 #include <SFML/System/Clock.hpp>
 #include <SFML/Window/Event.hpp>
-#include <SFML/Graphics/CircleShape.hpp>
 
-int main()
-{
+int main() {
     sf::RenderWindow window(sf::VideoMode(640, 480), "ImGui + SFML = <3");
     window.setFramerateLimit(60);
     ImGui::SFML::Init(window);
@@ -29,7 +29,7 @@ int main()
         ImGui::SFML::Update(window, deltaClock.restart());
 
         ImGui::ShowDemoWindow();
-        
+
         ImGui::Begin("Hello, world!");
         ImGui::Button("Look at this pretty button");
         ImGui::End();
@@ -41,6 +41,6 @@ int main()
     }
 
     ImGui::SFML::Shutdown();
-    
+
     return 0;
 }

imconfig-SFML.h

@@ -1,32 +1,27 @@
 // Add this to your imconfig.h
 
-#include <SFML/System/Vector2.hpp>
 #include <SFML/Graphics/Color.hpp>
+#include <SFML/System/Vector2.hpp>
 
 #include "imgui-SFML_export.h"
 
-#define IM_VEC2_CLASS_EXTRA                                             \
-    template <typename T>                                               \
-    ImVec2(const sf::Vector2<T>& v) {                                   \
-        x = static_cast<float>(v.x);                                    \
-        y = static_cast<float>(v.y);                                    \
-    }                                                                   \
-                                                                        \
-    template <typename T>                                               \
-    operator sf::Vector2<T>() const {                                   \
-        return sf::Vector2<T>(x, y);                                    \
+#define IM_VEC2_CLASS_EXTRA           \
+    template<typename T>              \
+    ImVec2(const sf::Vector2<T>& v) { \
+        x = static_cast<float>(v.x);  \
+        y = static_cast<float>(v.y);  \
+    }                                 \
+                                      \
+    template<typename T>              \
+    operator sf::Vector2<T>() const { \
+        return sf::Vector2<T>(x, y);  \
     }
 
-#define IM_VEC4_CLASS_EXTRA                                             \
-    ImVec4(const sf::Color & c)                                         \
-        : x(c.r / 255.f), y(c.g / 255.f), z(c.b / 255.f), w(c.a / 255.f)\
-    {}                                                                  \
-    operator sf::Color() const {                                        \
-        return sf::Color(                                               \
-            static_cast<sf::Uint8>(x * 255.f),                          \
-            static_cast<sf::Uint8>(y * 255.f),                          \
-            static_cast<sf::Uint8>(z * 255.f),                          \
-            static_cast<sf::Uint8>(w * 255.f));                         \
+#define IM_VEC4_CLASS_EXTRA                                                                        \
+    ImVec4(const sf::Color& c) : x(c.r / 255.f), y(c.g / 255.f), z(c.b / 255.f), w(c.a / 255.f) {} \
+    operator sf::Color() const {                                                                   \
+        return sf::Color(static_cast<sf::Uint8>(x * 255.f), static_cast<sf::Uint8>(y * 255.f),     \
+                         static_cast<sf::Uint8>(z * 255.f), static_cast<sf::Uint8>(w * 255.f));    \
     }
 
 #define ImTextureID unsigned int