Artem Kharytoniuk decide to create it\u2019s own\u00a0version<\/a>\u00a0 and his goal is described in it\u2019s repo:<\/p>\n This repository contains updated version of the original Q3 codebase with reorganized code structure, compatibility fixes, build setup for the latest Visual Studio and modifications that update the core tech but preserve original gameplay, look and feel.<\/em><\/p>\n Let\u2019s compare the source code of the two projects\u00a0\u00a0and discover what improvements were\u00a0down in the Kenny edition version.<\/p>\n The whole picture<\/strong><\/p>\n Here\u2019s a summary of some metrics of the original code<\/p>\n And here\u2019s the summary of\u00a0the modified version<\/p>\n Here are some remarks after comparing their summaries:<\/p>\n Let\u2019s discover these metrics for each project:<\/p>\n The original code<\/p>\n And for the modified code<\/p>\n Let\u2019s go further and compare deeply the differences between the two versions.<\/p>\n Modularity<\/strong><\/p>\n Modularity is a software design technique that increases the extent to which software is composed from separate parts , you can manage and maintain modular code easily.<\/p>\n For procedural language like C \u00a0where no logical artifacts like namespace, component or class does not exist, we can modularize by using directories and files.<\/p>\n In the modified version, there are some refactoring concerning the folders structure. here\u2019s an example of the refactoring where the folders related to the engine are isolated in the engine directory.<\/p>\n <\/p>\n Encapsulation<\/strong><\/p>\n Encapsulation \u00a0is the hiding of functions and data which are internal to an implementation. \u00a0In C, encapsulation is performed by using the keyword static . These entities are called file-scope functions and variables.<\/p>\n Let\u2019s search for all static functions for the original code:<\/p>\n Many methods are declared as static to enforce the encapsulation. However there are many other ones not declared as static.<\/p>\n We can use the Metric view to\u00a0have a good idea how many functions are static. In the Metric View, the code base is represented through a Treemap. Treemapping is a method for displaying tree-structured data by using nested rectangles. The tree structure used in a CppDepend treemap is the usual code hierarchy:<\/p>\n The treemap view provides a useful way to represent the result of a CQLinq request, so we can visually see the types concerned by the request.<\/p>\n As we can observe almost all the functions from renderer and cgame projects are declared as static, which is not the case for the other projects where only few functions are declared as static.<\/p>\n Did the modified version enforce the encapsulation?<\/p>\n Here\u2019s the CQLinq result of the static functions query:<\/p>\n There are less static functions than the original code, mainly because many functions were removed due to the refactoring, and this new version does not enforce more than the original one the encapsulation.<\/p>\n Usage of structs to store the data model<\/strong><\/p>\n In C programing the functions uses variables to acheive their treatments, theses variables could be:<\/p>\n Each project has it\u2019s data model which could be used by many source files, using global variables is a solution but not the good one, using structs to group data is more recommended.<\/p>\n Let\u2019s search for global variables with a primitive type: Only 166 variables from 9084 fields could be refactored to make them const, static or embed them in a struct.<\/p>\n And here\u2019s the same quey for the modified code<\/p>\n few new global variables candidate to be refactored are added to the new code. For that we can search for the primitive global variables , not static , not const and not changed in the source code:<\/p>\n some of them like \u00a0multi_texture_add_frag_spv_size or multi_texture_clipping_plane_vert_spv_size \u00a0added in the code could be declared as const.<\/p>\n Code Smells in two projects<\/strong><\/p>\n Types with too many fields<\/em><\/p>\n Let\u2019s search for structs with more than 30 fields:<\/p>\n And here\u2019s the result for the modified version<\/p>\n Some big structs were refactored, for example the number of fields of cgMedia_t passed 258 from to 199 fields.<\/p>\n Too big functions<\/em><\/p>\n Here\u2019s from the\u00a0linux coding style web page<\/a>, an\u00a0advice about the length of functions:<\/p>\n Let\u2019s search for functions where the number of lines of code is more than 50 for the original code: And here\u2019s the same result for the modified version:<\/p>\n Many big functions are gone, some of them are completly removed and the other ones are refactored.<\/p>\n Functions with too many parameters<\/em><\/p>\n Functions\u00a0where NbParameters > 8\u00a0might be painful to call \u00a0and might degrade performance. Another alternative is to provide \u00a0a structure dedicated to handle arguments passing. Here are the functions concerned for the original code<\/p>\n And here\u2019s the result for the modified version:<\/p>\n only very few functions has more than 8 parameters in both versions.<\/p>\n Functions with too many \u00a0local variables<\/em><\/p>\n Methods where NbVariables is higher than 8\u00a0are hard to understand and maintain. Methods where NbVariables is higher than 15 are extremely complex and should be split in smaller methods (except if they are automatically generated by a tool) Here\u2019s the result for the original code:<\/p>\n And the result for the modified one<\/p>\n Some added functions in the new modified version have more thann 15 variables, vk_initialize() is an added function with 73 ariables.<\/p>\n Functions too complex<\/strong><\/p>\n Many metrics exist to detect complex functions, NBLinesOfCode,Number of parameters and number of local variables are the basic ones.<\/p>\n There are other interesting metrics to detect complex functions:<\/p>\n The max value tolerated for these metrics depends more on the team choices, there\u2019s no standard values.<\/p>\n Let\u2019s search for functions candidate to be refactored for the original code: And the modified one:<\/p>\n <\/p>\n We can observe that many complex functions are removed or refactored.<\/p>\n \u00a0Conclusion<\/strong><\/p>\n The original source code of Quake III is well implemented, few code smells are detected. However a big clean was introduced in the modified version where many functions and variables were removed, some structs are refactored and the physical structure a little changed.<\/p>\n","protected":false},"excerpt":{"rendered":" Quake III Arena is a multiplayer-focused first-person shooter video game released in December 1999. The game was developed by id Software. Quake III was a very popular game and even now it\u2019s still popular and many gamers enjoy with it. The original source code of Quake3 can be found\u00a0here\u00a0. Artem Kharytoniuk decide to create it\u2019s … Continue reading “Comparing Quake3 Original and Kenny Edition Codebases”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[7,212,24],"class_list":["post-390","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-c","tag-kenny-edition","tag-quake"],"_links":{"self":[{"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/posts\/390","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/comments?post=390"}],"version-history":[{"count":5,"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/posts\/390\/revisions"}],"predecessor-version":[{"id":1502,"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/posts\/390\/revisions\/1502"}],"wp:attachment":[{"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/media?parent=390"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/categories?post=390"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/cppdepend.com\/blog\/wp-json\/wp\/v2\/tags?post=390"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}![\"quake4\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake4.png\")
<\/p>\n![\"quake1\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake1.png\")
<\/p>\n\n
![\"quake2\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake2-2.png\")
<\/p>\n![\"quake3\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake3.png\")
<\/p>\n![\"quake5\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake5.png\")
<\/p>\n![\"quake6\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake6.png\")
<\/p>\n\n
![\"quake7\"](\"http:\/\/cppdepend.com\/img\/quake7.png\")
<\/p>\n![\"quake8\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake8.png\")
<\/p>\n\n
\n<\/a><\/p>\n![\"quake11\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake11.png\")
<\/p>\n![\"quake12\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake12.png\")
<\/p>\n![\"quake22\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake22.png\")
<\/p>\n![\"quake13\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake13.png\")
<\/p>\n![\"quake14\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake14.png\")
<\/p>\nFunctions should be short and sweet, and do just one thing. They should\r\nfit on one or two screenfuls of text (the ISO\/ANSI screen size is 80x24,\r\nas we all know), and do one thing and do that well.\r\n\r\nThe maximum length of a function is inversely proportional to the\r\ncomplexity and indentation level of that function. So, if you have a\r\nconceptually simple function that is just one long (but simple)\r\ncase-statement, where you have to do lots of small things for a lot of\r\ndifferent cases, it's OK to have a longer function.<\/pre>\n
\n<\/a><\/p>\n![\"quake23\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake23.png\")
<\/p>\n![\"quake16\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake16.png\")
<\/p>\n
\n<\/a><\/p>\n![\"quake18\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake18.png\")
<\/p>\n![\"quake17\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake17.png\")
<\/p>\n
\n<\/a><\/p>\n![\"quake20\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake20.png\")
<\/p>\n![\"quake21\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake21.png\")
<\/p>\n\n
\n<\/a><\/p>\n![\"quake24\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake24.png\")
<\/p>\n![\"quake25\"](\"http:\/\/cppdepend.com\/wordpress\/wp-content\/uploads\/2017\/06\/quake25.png\")
<\/p>\n