From 21441ab5aac05b57e1208ec03a4e69d6da25c71b Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Thu, 3 Oct 2013 23:56:01 +0200 Subject: [PATCH] [DEV] coding style in progress --- bakaSed.sh | 120 ++++++++++++++++++++++++++++++++++++++++++++++++ codingStyle.txt | 47 +++++++++++++++++-- external/agg | 2 +- external/ejson | 2 +- external/esvg | 2 +- external/etk | 2 +- external/exml | 2 +- replaceSed.sh | 16 +++++++ 8 files changed, 184 insertions(+), 9 deletions(-) create mode 100755 bakaSed.sh create mode 100755 replaceSed.sh diff --git a/bakaSed.sh b/bakaSed.sh new file mode 100755 index 00000000..f0a6029d --- /dev/null +++ b/bakaSed.sh @@ -0,0 +1,120 @@ +#!/bin/bash + +replaceSed.sh "==" " == " +replaceSed.sh "==" " == " +replaceSed.sh "==" " == " +replaceSed.sh " == " " == " +replaceSed.sh " == " " == " +replaceSed.sh " == " " == " +replaceSed.sh " == " " == " + +replaceSed.sh "\.PushBack(" ".pushBack(" +replaceSed.sh "->PushBack(" "->pushBack(" +replaceSed.sh " PushBack" " pushBack" +replaceSed.sh "\tPushBack" "\tpushBack" +replaceSed.sh "::PushBack" "::pushBack" + +replaceSed.sh "\.PopBack(" ".popBack(" +replaceSed.sh "->PopBack(" "->popBack(" +replaceSed.sh " PopBack" " popBack" +replaceSed.sh "\tPopBack" "\tpopBack" +replaceSed.sh "::PopBack" "::popBack" + +replaceSed.sh "\.Size" ".size" +replaceSed.sh "->Size" "->size" +replaceSed.sh " Size" " size" +replaceSed.sh "\tSize" "\tsize" +replaceSed.sh "::Size" "::size" + +replaceSed.sh "\.Clear()" ".clear()" +replaceSed.sh "->Clear()" "->clear()" +replaceSed.sh " Clear" " clear" +replaceSed.sh "\tClear" "\tclear" +replaceSed.sh "::Clear" "::clear" + +replaceSed.sh "\.To" ".to" +replaceSed.sh "->To" "->to" +replaceSed.sh " To" " to" +replaceSed.sh "\tTo" "\tto" +replaceSed.sh "::To" "::to" + +replaceSed.sh "\.Is" ".is" +replaceSed.sh "->Is" "->is" +replaceSed.sh " Is" " is" +replaceSed.sh "\tIs" "\tis" +replaceSed.sh "::Is" "::is" + +replaceSed.sh "\.Exist()" ".exist()" +replaceSed.sh "->Exist()" "->exist()" +replaceSed.sh " Exist" " exist" +replaceSed.sh "\tExist" "\texist" +replaceSed.sh "::Exist" "::exist" + +replaceSed.sh "\.Add" ".add" +replaceSed.sh "->Add" "->add" +replaceSed.sh " Add" " add" +replaceSed.sh "\tAdd" "\tadd" +replaceSed.sh "::Add" "::add" + +replaceSed.sh "\.Get" ".get" +replaceSed.sh "->Get" "->get" +replaceSed.sh " Get" " get" +replaceSed.sh "\tGet" "\tget" +replaceSed.sh "::Get" "::get" + +replaceSed.sh "\.Set" ".set" +replaceSed.sh "->Set" "->set" +replaceSed.sh " Set" " set" +replaceSed.sh "\tSet" "\tset" +replaceSed.sh "::Set" "::set" + +replaceSed.sh "\.Insert" ".insert" +replaceSed.sh "->Insert" "->insert" +replaceSed.sh " Insert" " insert" +replaceSed.sh "\tInsert" "\tinsert" +replaceSed.sh "::Insert" "::insert" + +replaceSed.sh "\.Parse" ".parse" +replaceSed.sh "->Parse" "->parse" +replaceSed.sh " Parse" " parse" +replaceSed.sh "\tParse" "\tparse" +replaceSed.sh "::Parse" "::parse" + +replaceSed.sh "\.Generate" ".generate" +replaceSed.sh "->Generate" "->generate" +replaceSed.sh " Generate" " generate" +replaceSed.sh "\tGenerate" "\tgenerate" +replaceSed.sh "::Generate" "::generate" + + +replaceSed.sh "\.Transfert" ".transfert" +replaceSed.sh "->Transfert" "->transfert" +replaceSed.sh " Transfert" " transfert" +replaceSed.sh "\tTransfert" "\ttransfert" +replaceSed.sh "::Transfert" "::transfert" + +replaceSed.sh "\.Duplicate" ".duplicate" +replaceSed.sh "->Duplicate" "->duplicate" +replaceSed.sh " Duplicate" " duplicate" +replaceSed.sh "\tDuplicate" "\tduplicate" +replaceSed.sh "::Duplicate" "::duplicate" + + +replaceSed.sh "\.Draw" ".draw" +replaceSed.sh "->Draw" "->draw" +replaceSed.sh " Draw" " draw" +replaceSed.sh "\tDraw" "\tdraw" +replaceSed.sh "::Draw" "::draw" + +replaceSed.sh "\.Check" ".check" +replaceSed.sh "->Check" "->check" +replaceSed.sh " Check" " check" +replaceSed.sh "\tCheck" "\tcheck" +replaceSed.sh "::Check" "::check" + + +replaceSed.sh "\.Count" ".count" +replaceSed.sh "->Count" "->count" +replaceSed.sh " Count" " count" +replaceSed.sh "\tCount" "\tcount" +replaceSed.sh "::Count" "::count" diff --git a/codingStyle.txt b/codingStyle.txt index 8d5fb9fb..0a3d9c80 100644 --- a/codingStyle.txt +++ b/codingStyle.txt @@ -22,7 +22,7 @@ We need to use the same coding style in c and c++ to simplify inter-reading code * @param[in,out] _xxxx Comment on the variable * @return my return explanation */ - - enumeration comment: + - one line documlentation: xxxxx, //!< my comment --------------------------- @@ -40,7 +40,6 @@ We need to use the same coding style in c and c++ to simplify inter-reading code he will be able to do it. When you set a brace '{' you need to add a brace, and when you set a stop brace '}' you need to remove a tab - To be simple : (tab stop at the 'if' start) if: if ( xxx == yyy @@ -80,6 +79,17 @@ We need to use the same coding style in c and c++ to simplify inter-reading code namespace appl { void get(void); }; + For special element like : you might add a tabulation too + case xxx: + actions... + public: + definition ... + An exception for the inline function inside c++ header: + class Plop { + private: + int32_t m_value; //!< my value of money gain + public: + int32_t getValue(void) const { return m_value; }; ---------------- -- 4: types -- @@ -131,12 +141,41 @@ We need to use the same coding style in c and c++ to simplify inter-reading code - enum: Camel case with first letter in lower case. enum myEnum { + myEnumDef1, + myEnumDef2, + myEnumDef3, + }; - structure (C only) use naming like Classes (and for mamber too) - + - minimum size : Do not use variable with size <3, the for a iterator + for a 'for' : + for (int32_t iii=0; iii0 value, you can set what you want. -------------------------- --- 8: C++ specificity -- +-- 9: C++ specificity -- -------------------------- - STL You can use the Stl, but the porting and the result can be diff --git a/external/agg b/external/agg index 64280cda..ed066131 160000 --- a/external/agg +++ b/external/agg @@ -1 +1 @@ -Subproject commit 64280cda086d931f7af6ac4ce29e181ceee8f45b +Subproject commit ed0661317bb59183336d11b13f76025bdf08bb34 diff --git a/external/ejson b/external/ejson index 299ca3e6..a788a3c4 160000 --- a/external/ejson +++ b/external/ejson @@ -1 +1 @@ -Subproject commit 299ca3e6b2edf15cc8156b97d9e59b3d3c3a4fa7 +Subproject commit a788a3c450585c42dd59cf8e3813bd1a4a241c5e diff --git a/external/esvg b/external/esvg index 32c4469c..b80dbfd2 160000 --- a/external/esvg +++ b/external/esvg @@ -1 +1 @@ -Subproject commit 32c4469c127fed6ff4f3c9a7031eb7e76f72c43b +Subproject commit b80dbfd29830143bb2db0f6057e9d7bd0d530fb0 diff --git a/external/etk b/external/etk index dfcb78c0..006233a2 160000 --- a/external/etk +++ b/external/etk @@ -1 +1 @@ -Subproject commit dfcb78c081c6d975cf88dcb2e4cd1b0ada289c67 +Subproject commit 006233a2fdb26276294771d7780492215b115363 diff --git a/external/exml b/external/exml index 75ef4d18..33d1e950 160000 --- a/external/exml +++ b/external/exml @@ -1 +1 @@ -Subproject commit 75ef4d184ade2791d1db3b3d0f40b8ae46aa7f45 +Subproject commit 33d1e95085e090eec9860213ba97a1616442d159 diff --git a/replaceSed.sh b/replaceSed.sh new file mode 100755 index 00000000..cb4c460f --- /dev/null +++ b/replaceSed.sh @@ -0,0 +1,16 @@ +#!/bin/bash + + +listFiles=" `find . -name "*.cpp"` " +listFiles+=" `find . -name "*.c"` " +listFiles+=" `find . -name "*.h"` " +#listFiles+=" `find . -name "*.mk"` " + +echo "Replace : \"$1\" ==> \"$2\"" + +for iii in $listFiles +do + echo "* File : "$iii + sed -i "s|$1|$2|" $iii +done +