Skip to main content

How to Check Format of Your C++ Code

As a concern of a group work in development, understandability and standards have a significant place. For the purposes of suitability, each work done by different team members should have a coherence. This behavior avoids different code writings which may confuse developers. It is also a control mechanism against unexpected weird code blocks. Maybe someone in your team has an interest to write his code squeezed in a square block :)

The team is coding in c++. They agree on a coding standard. Each member will check their code before committing. For this purpose, I have discovered clang-format tool which provides easy and quick formatting. Its integration to CLion is also simple. However, if you would like to do a double check before merging a code, there is more to do. 

Continuous integration is an option to check whether the committed code is in desired format or not. If it does not suit, then CI job fails. At the very beginning, related job is started. If it fails, it will force the committer to correct the code. Otherwise, the work will be ignored. Currently, I could not find a complete and mature solution which provides this functionality. clang-format only gives the formatted version of the given input. But it does not have a verification functionality. However, it is elegant, light-weight and effective in formatting. Therefore, I have written a bash script (see the code block below) to achieve this goal by using clang-format. It recursively traverses all files in a directory whose path is passed as an argument. Names of files which violate the standards are printed out. If such files exist, the script returns 1 which is a fail state. In this case, the CI job fails. If all files satisfy the standards, the script successfully concludes. Then, upcoming CI jobs, if exist, start. Alternatively, the script can be run locally to see which files need an update.

Each member can check their code by using clang-format locally. For the coherence in a group work, an extra check may be necessary. It depends on the team's concern. Free to use this code block if you think it is useful for you. If you think there is a better way or if you have an idea to improve this way further, please drop a comment. Happy coding.
Labels:

Comments

Post a Comment

Popular posts from this blog

Integration of MuPDF Project as a Library into an Android Studio Project

I have needed to use MuPDF library in my android project. After some research, I have seen that there are many integration tutorials but, but integrated projects are developed on Eclipse. For projects on AndroidStudio+Gradle, there is no example. I mean there is no specific example which exactly refers to this issue. So, after achieving my goal, I want to share the steps publicly so that it can be reused by others.
27 comments
Read more

A Way To Monetize Your Kivy Game

While I am building my game, I look for a way to monetize it. This will be my first game, so it is also the first to attempt earning money with an App. I am also not familiar to monetization companies. So, I have done a search to find an appropriate ads network which can be easily integrated with kivy . The first and only company who provides a sdk for kivy is RevMob . I integrated RevMob sdk and tested it. Unfortunately, it doesn't have a good performance and FullScreen Ads crashes. Just links will work. Therefore, RevMob option is not really preferable since ads need to be visually effective. You can also integrate android sdk of any ads network by using pyjnius . In this post, I will show how to use Adbuddiz sdk with kivy.
6 comments
Read more

Encoding multi-dimensional value into 1-D with preserving closeness

After a very long time, this will be my first post. I hope that it will not be the last, and the rest will come. For a project about taxi trajectory prediction, I have applied k-NN algorithm on coordinate sequence of taxi trips. Did I have promising results? Well, it is arguable, but I have discovered some good techniques. One of them is Z-order curve (Figure 1). Figure 1: Four levels of Z-ordering (taken from Wikipedia  page) I was looking for a technique to decrease dimensionality of 2-D coordinate representation (lat-lon) into 1-D . But on this 1-D value, I would like to apply k-NN algorithm. For this purpose, 1-D values must preserve the closeness of two different coordinates. If I do linear ordering of latitude and longitude values, I couldn't achieve this goal, because closeness will depend on only one value which is placed on the right-most. Let's assume I do linear ordering as lat-lon:
11 comments
Read more