Added linting in Github Actions with clang-format

Author: abodelot

.clang-format

@@ -0,0 +1,20 @@
+---
+BasedOnStyle: Webkit
+AlignAfterOpenBracket: BlockIndent
+AlignConsecutiveMacros: true
+AlignTrailingComments: true
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AlwaysBreakTemplateDeclarations: Yes
+BreakBeforeBraces: Allman
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: AfterColon
+ColumnLimit: 120
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+Cpp11BracedListStyle: true
+MaxEmptyLinesToKeep: 2
+PackConstructorInitializers: Never
+SortIncludes: false
+SpaceBeforeCtorInitializerColon: false
+SpaceBeforeInheritanceColon: false
+SpaceBeforeRangeBasedForLoopColon: false

.github/workflows/ci.yml

@@ -1,6 +1,15 @@
 on: [push, pull_request]
 
 jobs:
+  lint:
+    name: Clang-format
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: sudo apt install clang-format
+      - name: Run clang-format
+        run: clang-format $(find src -type f) --dry-run -Werror
   build:
     name: Compile
     runs-on: ubuntu-latest

compile_flags.txt

@@ -0,0 +1,6 @@
+-I./src
+-std=c++11
+-Wall
+-Wextra
+-Wshadow
+-Wwrite-strings

lint.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+clang-format $(find src -type f) -i
+echo "Done"

src/Gui/Button.hpp

@@ -23,8 +23,8 @@ class Button: public Widget
 
     const sf::String& getString() const;
 
-    // callbacks ---------------------------------------------------------------
-
+protected:
+    // Callbacks
     void onStateChanged(State state) override;
     void onMouseMoved(float x, float y) override;
     void onMousePressed(float x, float y) override;

src/Gui/CheckBox.hpp

@@ -21,18 +21,18 @@ class CheckBox: public Widget
 
     void check(bool checked);
 
-    // callbacks ---------------------------------------------------------------
-
+protected:
+    // Callbacks
     void onStateChanged(State state) override;
     void onMouseReleased(float x, float y) override;
     void onKeyPressed(const sf::Event::KeyEvent& key) override;
 
 private:
     void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
-    Box   m_box;
+    Box m_box;
     Cross m_cross;
-    bool  m_checked;
+    bool m_checked;
 };
 
 }

src/Gui/Image.hpp

@@ -23,7 +23,7 @@ class Image: public Widget
 private:
     void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
-    sf::Vertex         m_vertices[4];
+    sf::Vertex m_vertices[4];
     const sf::Texture* m_texture;
 };
 

src/Gui/Label.cpp

@@ -63,8 +63,7 @@ void Label::draw(sf::RenderTarget& target, sf::RenderStates states) const
 void Label::updateGeometry()
 {
     Widget::setSize(
-        m_text.getLocalBounds().width + Theme::PADDING * 2,
-        m_text.getLocalBounds().height + Theme::PADDING * 2
+        m_text.getLocalBounds().width + Theme::PADDING * 2, m_text.getLocalBounds().height + Theme::PADDING * 2
     );
 }
 

src/Gui/Layouts/Layout.hpp

@@ -31,8 +31,8 @@ class Layout: public Widget
     Widget* add(Widget* widget);
 
     /// Helpers
-    Button*     addButton(const sf::String& string, std::function<void(void)> callback);
-    Label*      addLabel(const sf::String& string);
+    Button* addButton(const sf::String& string, std::function<void(void)> callback);
+    Label* addLabel(const sf::String& string);
     FormLayout* addFormLayout();
     HBoxLayout* addHBoxLayout();
     VBoxLayout* addVBoxLayout();
@@ -50,7 +50,7 @@ class Layout: public Widget
     void onKeyReleased(const sf::Event::KeyEvent& key) override;
     void onTextEntered(sf::Uint32 unicode) override;
 
-    Layout* toLayout() override { return this; } // hack?
+    inline Layout* toLayout() override { return this; }
     bool focusNextWidget();
     bool focusPreviousWidget();
 
@@ -64,10 +64,10 @@ class Layout: public Widget
      */
     bool focusWidget(Widget* widget);
 
-    Widget*   m_first;
-    Widget*   m_last;
-    Widget*   m_hover;
-    Widget*   m_focus;
+    Widget* m_first;
+    Widget* m_last;
+    Widget* m_hover;
+    Widget* m_focus;
 };
 
 }

src/Gui/Menu.hpp

@@ -7,14 +7,17 @@
 namespace gui
 {
 
+/**
+ * Entry point for the GUI.
+ * A Menu is a VBoxLayout with a general onEvent handler
+ */
 class Menu: public gui::VBoxLayout
 {
 public:
     Menu(sf::RenderTarget& window);
 
     /**
-     * Handle event and send it to widgets
-     * @return triggered widget ID, or -1 if none
+     * Handle an SFML event and send it to widgets
      */
     void onEvent(const sf::Event& event);
 

src/Gui/OptionsBox.hpp

@@ -52,8 +52,8 @@ class OptionsBox: public Widget
      */
     void selectPrevious();
 
-    // callbacks ---------------------------------------------------------------
-
+protected:
+    // Callbacks
     void onStateChanged(State state) override;
     void onMouseMoved(float x, float y) override;
     void onMousePressed(float x, float y) override;
@@ -75,13 +75,13 @@ class OptionsBox: public Widget
     };
 
     typedef std::vector<Item> ItemVector;
-    ItemVector         m_items;
-    size_t             m_current_index;
+    ItemVector m_items;
+    size_t m_currentIndex;
 
     // Visual components
-    ItemBox<sf::Text>  m_box;
-    ItemBox<Arrow>     m_arrow_left;
-    ItemBox<Arrow>     m_arrow_right;
+    ItemBox<sf::Text> m_box;
+    ItemBox<Arrow> m_arrowLeft;
+    ItemBox<Arrow> m_arrowRight;
 };
 
 }

src/Gui/OptionsBox.inl

@@ -5,24 +5,24 @@ namespace gui
 
 template <class T>
 OptionsBox<T>::OptionsBox():
-    m_current_index(-1),
+    m_currentIndex(-1),
     m_box(Box::Input),
-    m_arrow_left(Arrow(Arrow::Left)),
-    m_arrow_right(Arrow(Arrow::Right))
+    m_arrowLeft(Arrow(Arrow::Left)),
+    m_arrowRight(Arrow(Arrow::Right))
 {
     // Build visual components
     m_box.item().setFont(Theme::getFont());
     m_box.item().setCharacterSize(Theme::textSize);
     m_box.setSize(Theme::minWidgetWidth, Theme::getBoxHeight());
 
     // Pack left arrow
-    m_arrow_left.setSize(Theme::getBoxHeight(), Theme::getBoxHeight());
-    m_arrow_left.centerItem(m_arrow_left.item());
+    m_arrowLeft.setSize(Theme::getBoxHeight(), Theme::getBoxHeight());
+    m_arrowLeft.centerItem(m_arrowLeft.item());
 
     // Pack right arrow
-    m_arrow_right.setSize(Theme::getBoxHeight(), Theme::getBoxHeight());
-    m_arrow_right.setPosition(m_box.getSize().x - Theme::getBoxHeight(), 0);
-    m_arrow_right.centerItem(m_arrow_right.item());
+    m_arrowRight.setSize(Theme::getBoxHeight(), Theme::getBoxHeight());
+    m_arrowRight.setPosition(m_box.getSize().x - Theme::getBoxHeight(), 0);
+    m_arrowRight.centerItem(m_arrowRight.item());
 
     // Widget local bounds
     setSize(m_box.getSize());
@@ -40,8 +40,8 @@ void OptionsBox<T>::addItem(const sf::String& label, const T& value)
     if (width > getSize().x)
     {
         m_box.setSize(width, Theme::getBoxHeight());
-        m_arrow_right.setPosition(width - Theme::getBoxHeight(), 0);
-        m_arrow_right.centerItem(m_arrow_right.item());
+        m_arrowRight.setPosition(width - Theme::getBoxHeight(), 0);
+        m_arrowRight.centerItem(m_arrowRight.item());
         setSize(m_box.getSize());
     }
 
@@ -54,7 +54,7 @@ void OptionsBox<T>::selectItem(size_t item_index)
 {
     if (item_index < m_items.size())
     {
-        m_current_index = item_index;
+        m_currentIndex = item_index;
         m_box.item().setString(m_items[item_index].label);
         m_box.centerText(m_box.item());
     }
@@ -64,14 +64,14 @@ void OptionsBox<T>::selectItem(size_t item_index)
 template <class T>
 const T& OptionsBox<T>::getSelectedValue() const
 {
-    return m_items[m_current_index].value;
+    return m_items[m_currentIndex].value;
 }
 
 
 template <class T>
 size_t OptionsBox<T>::getSelectedIndex() const
 {
-    return m_current_index;
+    return m_currentIndex;
 }
 
 
@@ -81,7 +81,7 @@ void OptionsBox<T>::selectNext()
     if (m_items.size() > 1)
     {
         // Get next item index
-        selectItem(m_current_index == (m_items.size() - 1) ? 0 : m_current_index + 1);
+        selectItem(m_currentIndex == (m_items.size() - 1) ? 0 : m_currentIndex + 1);
         triggerCallback();
     }
 }
@@ -93,7 +93,7 @@ void OptionsBox<T>::selectPrevious()
     if (m_items.size() > 1)
     {
         // Get previous item index
-        selectItem(m_current_index == 0 ? m_items.size() - 1 : m_current_index - 1);
+        selectItem(m_currentIndex == 0 ? m_items.size() - 1 : m_currentIndex - 1);
         triggerCallback();
     }
 }
@@ -104,8 +104,8 @@ void OptionsBox<T>::draw(sf::RenderTarget& target, sf::RenderStates states) cons
 {
     states.transform *= getTransform();
     target.draw(m_box, states);
-    target.draw(m_arrow_left, states);
-    target.draw(m_arrow_right, states);
+    target.draw(m_arrowLeft, states);
+    target.draw(m_arrowRight, states);
 }
 
 
@@ -134,8 +134,8 @@ void OptionsBox<T>::onStateChanged(State state)
     // Hovered state is handled in the onMouseMoved callback
     if (state == StateDefault || state == StateFocused)
     {
-        m_arrow_left.applyState(state);
-        m_arrow_right.applyState(state);
+        m_arrowLeft.applyState(state);
+        m_arrowRight.applyState(state);
         m_box.applyState(state);
     }
 }
@@ -144,34 +144,34 @@ void OptionsBox<T>::onStateChanged(State state)
 template <class T>
 void OptionsBox<T>::onMouseMoved(float x, float y)
 {
-    updateArrow(m_arrow_left, x, y);
-    updateArrow(m_arrow_right, x, y);
+    updateArrow(m_arrowLeft, x, y);
+    updateArrow(m_arrowRight, x, y);
 }
 
 
 template <class T>
 void OptionsBox<T>::onMousePressed(float x, float y)
 {
-    if (m_arrow_left.containsPoint(x, y))
-        m_arrow_left.press();
+    if (m_arrowLeft.containsPoint(x, y))
+        m_arrowLeft.press();
 
-    else if (m_arrow_right.containsPoint(x, y))
-        m_arrow_right.press();
+    else if (m_arrowRight.containsPoint(x, y))
+        m_arrowRight.press();
 }
 
 
 template <class T>
 void OptionsBox<T>::onMouseReleased(float x, float y)
 {
-    if (m_arrow_left.containsPoint(x, y))
+    if (m_arrowLeft.containsPoint(x, y))
     {
         selectPrevious();
-        m_arrow_left.release();
+        m_arrowLeft.release();
     }
-    else if (m_arrow_right.containsPoint(x, y))
+    else if (m_arrowRight.containsPoint(x, y))
     {
         selectNext();
-        m_arrow_right.release();
+        m_arrowRight.release();
     }
 }
 
@@ -182,12 +182,12 @@ void OptionsBox<T>::onKeyPressed(const sf::Event::KeyEvent& key)
     if (key.code == sf::Keyboard::Left)
     {
         selectPrevious();
-        m_arrow_left.press();
+        m_arrowLeft.press();
     }
     else if (key.code == sf::Keyboard::Right)
     {
         selectNext();
-        m_arrow_right.press();
+        m_arrowRight.press();
     }
 }
 
@@ -197,11 +197,11 @@ void OptionsBox<T>::onKeyReleased(const sf::Event::KeyEvent& key)
 {
     if (key.code == sf::Keyboard::Left)
     {
-        m_arrow_left.release();
+        m_arrowLeft.release();
     }
     else if (key.code == sf::Keyboard::Right)
     {
-        m_arrow_right.release();
+        m_arrowRight.release();
     }
 }
 

src/Gui/ProgressBar.cpp

@@ -36,7 +36,7 @@ void ProgressBar::setValue(float value)
     float x = Theme::borderSize + (getSize().x - Theme::borderSize * 2) * value / 100;
     m_bar[1].position.x = m_bar[2].position.x = x;
 
-    m_text.setString(std::to_string((int) value) + "%");
+    m_text.setString(std::to_string((int)value) + "%");
     m_box.centerText(m_text);
 
     m_value = value;

src/Gui/ProgressBar.hpp

@@ -23,10 +23,10 @@ class ProgressBar: public Widget
 private:
     void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
-    Box        m_box;
+    Box m_box;
     sf::Vertex m_bar[4];
-    sf::Text   m_text;
-    float      m_value;
+    sf::Text m_text;
+    float m_value;
 };
 
 }