├── .gitignore
├── README.md
├── codeCleaningTools
    └── commentOutUnusedParameters.pl
├── eclipse-tools
    ├── eclipseProjectMigrator
    └── install_eclipse.sh
├── formatter
    ├── eclipse_style.xml
    └── emacs_style.el
└── wiki
    ├── bs_job.png
    ├── bs_overview.png
    ├── build-passed.png
    └── pr-build-server-status.png


/.gitignore:
--------------------------------------------------------------------------------
1 | /.project
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | #### This repository contains tools and a wiki to aid efficient programming and high usability of the resulting software
2 | 
3 | See the [wiki](https://github.com/ethz-asl/programming_guidelines/wiki) for more information.
4 | 
5 | 
6 | 


--------------------------------------------------------------------------------
/codeCleaningTools/commentOutUnusedParameters.pl:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env perl
  2 | 
  3 | use Getopt::Long;
  4 | my $force   = 0;
  5 | my $prefix = "";
  6 | my $help =  0;
  7 | my $verbose = 0;
  8 | my $debug = 0;
  9 | $result = GetOptions (
 10 |                     "prefix|p=s"   => \$prefix,
 11 |                     "replacement|r=s" => \$prefixReplacement,
 12 |                     "force|f"  => \$force,
 13 |                     "verbose|v"  => \$verbose,
 14 |                     "debug|d"  => \$debug,
 15 |                     "help|h|usage|u" => \$help
 16 |                     )
 17 | 	or $help = 1;
 18 | 
 19 | if($help){
 20 | 	print "USAGE: $ARGV[0] [(-h|--help)] | [-f|--force] [-v|--verbose] [-p|--prefix <PREFIX>] [-r|--replacement <PREFIX_REPLACEMENT>] [<INPUT_FILE>]\n";
 21 | 	exit(-1);
 22 | }
 23 | 
 24 | #Just feed in build output on stdin. 
 25 | #Tested mostly with Jenkins raw build output (http://129.132.38.183:8080/job/????/consoleText).
 26 | #runs best directly in the git work tree.
 27 | 
 28 | #use the two first positional arguments to replace path prefixes:
 29 | 
 30 | %ids=(); 
 31 | 
 32 | $pwd = $ENV{'PWD'};
 33 | $currentRev = qx(git rev-parse HEAD);
 34 | 
 35 | if(!$currentRev) {
 36 | 	print STDERR "WARNING: Could not retrieve current git revision! Please ensure manually that the code is identical to the compiled one!";
 37 | }else{
 38 | 	$currentRev =~s/\s+$//;
 39 | 	print "Current commit : '$currentRev'.\n";
 40 | }
 41 | 
 42 | $revisionOk = 0;
 43 | 
 44 | while (<>){
 45 | 	$line = $_;
 46 | 	if($line =~/^ *Checking out Revision /){
 47 | 		my ($rev, $rest) = ($line =~/^ *Checking out Revision *([[:alnum:]]+)(.*)/i);
 48 | 		if($rest){
 49 | 			print "Jenkins used commit '$rev'.\n";
 50 | 			if($currentRev && $currentRev ne $rev){
 51 | 				print STDERR "Don't use compiler warnings from a different commit ($rev (Jenkins) != $currentRev ($pwd)! The line numbers may not match.\nTip: checkout commit $rev first!\n";
 52 | 				if(!$force) { exit -1; }
 53 | 			}
 54 | 		}
 55 | 	}
 56 | 	elsif($line=~/warning: unused\ parameter/) {
 57 | 		my ($status, $file, $lineNr, $name) = ($line =~/^(\[ *\d*%\])? *([^:]*):(\d\d*).*warning: unused parameter [‘?](\S*)[’?]/i);
 58 | 		if($file) {
 59 | 			$id = "$file:$lineNr:$name";
 60 | 			if($ids{$id}) { 
 61 | 				!$verbose or print "skipping duplicate : $id\n";
 62 | 				next; 
 63 | 			}
 64 | 			else { $ids{$id} = 1;}
 65 | 			
 66 | 			if(index($file, $prefix) == 0){
 67 | 				$file=~ s/^\Q$prefix\E/$prefixReplacement/;
 68 | 				!$verbose or print "processing unused parameter $id in $file\n";
 69 | 				
 70 | 				if( -e $file ){
 71 | 					$testAlreadyCmd = "sed -n '${lineNr},/{/p' '$file' | sed -n '\\#/\\* *$name *\\*/#q1; /{/q0'";
 72 | 					$ret = system($testAlreadyCmd);
 73 | 					!$debug or print "testing whether already applied with : $testAlreadyCmd -> $ret\n";
 74 | 					if($ret eq 256) {
 75 | 						print "replacing '$name' : already applied.\n";
 76 | 					}else {
 77 | 						$matcher = "$name\\( *\\([,)=]\\|\$\\)\\)";
 78 | 						$cmd = "sed -n '${lineNr},/{/p' '$file' | sed -n '\\#$matcher#q1'";
 79 | 						$ret = system($cmd);
 80 | 						!$debug or print "testing whether we can replace with : $cmd -> $ret\n";
 81 | 						if($ret eq 256){
 82 | 							$replacement = "/* $name */";
 83 | 							print "replacing '$name' with '$replacement'.\n";
 84 | 							system("sed -i '${lineNr},/{/{s#$matcher#$replacement\\1#; t quit; b}; b; :quit; n; b quit' '$file'");
 85 | 						}else{
 86 | 							print STDERR "$file:$lineNr :";
 87 | 							print STDERR "'WARNING: failed to replace '$name' in:\n";
 88 | 							system("sed -n '${lineNr},/{/p' '$file' >&2");
 89 | 							print STDERR "compiler warning: $_";
 90 | 						}
 91 | 					}
 92 | 				}
 93 | 				else {
 94 | 					print STDERR "WARNING: could not find file '$file'.\n";
 95 | 				}
 96 | 			}else {
 97 | 				print "ignoring '$file' - does not match prefix.\n";
 98 | 			}
 99 | 		}else{
100 | 			print "WARNING: could not understand : ", $_;
101 | 		}
102 | 	}
103 | }
104 | 
105 | 


--------------------------------------------------------------------------------
/eclipse-tools/eclipseProjectMigrator:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | PROG_NAME=$0
 4 | 
 5 | usage()
 6 | {
 7 | echo "usage: $PROG_NAME {<OPTION>} <SRC_DIR> <DEST_DIR>"
 8 | echo "This script migrates the eclipse configuration files from one project into an other directory: The project candidate."
 9 | echo "For that it will copy the configurations files while exchanging all occurrences of the SRC_DIR with DEST_DIR and all occurrence of SRC_NAME with DEST_NAME."
10 | echo "SRC_NAME and DEST_NAME are currently assumed to be the names of the SRC_DIR and DEST_DIR respectively."
11 | echo "Both SRC_DIR and DEST_DIR should be relative to the current working directory but without "../". The working directory should be a folder the catkin workspace's src folder."
12 | echo "OPTIONS:"
13 | echo -e "\t-h\tShow this message"
14 | echo -e "\t-f\tForce overwriting existing files"
15 | }
16 | 
17 | FORCE=
18 | while getopts "hf" OPTION
19 | do
20 | 	case $OPTION in
21 | 		h)
22 | 			usage
23 | 			exit 1
24 | 			;;
25 | 		f)
26 | 			FORCE=y
27 | 			;;
28 | 		?)
29 | 			usage
30 | 			exit
31 | 			;;
32 | 	esac
33 | done
34 | 
35 | shift $(($OPTIND-1))
36 | 
37 | SRC_DIR=${1%\/}
38 | shift
39 | DEST_DIR=${1%\/}
40 | shift
41 | 
42 | if [ "${SRC_DIR%%\.*}" != "${SRC_DIR}" -o "${DEST_DIR%%\.*}" != "${DEST_DIR}" ] ; then
43 | 	echo "Neither SRC_DIR nor DEST_DIR should contain any '.' or '..'. Best is to run the migrator directly from within the catkin workspace's src folder."
44 | 	exit -1;
45 | fi
46 | 
47 | if [ -z "$DEST_DIR" -o -n "$1" ]; then
48 | 	usage
49 | 	exit -1;
50 | fi
51 | 
52 | SRC_NAME=$(basename "$SRC_DIR")
53 | DEST_NAME=$(basename "$DEST_DIR")
54 | 
55 | echo "Using SRC_NAME=$SRC_NAME and DEST_NAME=$DEST_NAME."
56 | 
57 | if ! grep -qF "<name>$SRC_NAME</name>" "$SRC_DIR/.project" ; then
58 | 	echo "The src project's name is not $SRC_NAME. Not supported, yet."; 
59 | 	exit -1;
60 | fi
61 | 
62 | function listDir() {
63 | 	(cd "$SRC_DIR" && find "$1" 2>/dev/null || true)
64 | }
65 | 
66 | for f in .project .cproject $(listDir .settings) $(listDir .csettings); do
67 | 	S="$SRC_DIR/$f"
68 | 	D="$DEST_DIR/$f"
69 | 	if [ -f "$S" ] ;then
70 | 		echo "$S -> $D:"
71 | 		if [ "$FORCE" = "y" -o ! -e "$D" ] ; then
72 | 			mkdir -vp "$(dirname "$D")"
73 | 			sed  "/name[=>]/!s#$SRC_DIR#$DEST_DIR#g" "$S" > "$D"
74 | 			sed -i "s#\b$SRC_NAME\b#$DEST_NAME#g" "$D"
75 | 			echo "ok."
76 | 			git --no-pager diff --no-index --color-words "$S" "$D"
77 | 		else
78 | 			echo "already exists. skipping."
79 | 		fi
80 | 	fi
81 | done
82 | 


--------------------------------------------------------------------------------
/eclipse-tools/install_eclipse.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # install oracle java 7 (REALLY recomended for eclipse)
 4 | sudo add-apt-repository ppa:webupd8team/java
 5 | sudo apt-get update
 6 | sudo apt-get install oracle-java8-installer
 7 | 
 8 | 
 9 | # eclipse (copied from pascal gohl)  (merci)
10 | wget http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/luna/SR1/eclipse-cpp-luna-SR1-linux-gtk-x86_64.tar.gz
11 | # The link below is broken (Christian Gehring)
12 | # wget http://mirror.switch.ch/eclipse/technology/epp/downloads/release/luna/SR1/eclipse-cpp-luna-SR1-linux-gtk-x86_64.tar.gz
13 | tar -zxvf eclipse-cpp-luna-SR1-linux-gtk-x86_64.tar.gz
14 | sudo mv eclipse /opt
15 | sudo chown $USER -R /opt/eclipse/
16 | sudo ln -s /opt/eclipse/eclipse /usr/sbin/eclipse
17 | rm eclipse-cpp-luna-SR1-linux-gtk-x86_64.tar.gz
18 | 
19 | # give eclipse more memory
20 | sudo sed -i "s/-XX:MaxPermSize=256m/-XX:MaxPermSize=1024m/g" /opt/eclipse/eclipse.ini
21 | sudo sed -i "s/-Xms40m/-Xms512m/g" /opt/eclipse/eclipse.ini
22 | sudo sed -i "s/-Xmx512m/-Xmx1024m/g" /opt/eclipse/eclipse.ini
23 | 
24 | # setup unity link
25 | cat > eclipse.desktop << "EOF"
26 | [Desktop Entry]
27 | Name=Eclipse
28 | Type=Application
29 | Exec=eclipse
30 | Terminal=false
31 | Icon=eclipse
32 | Comment=Integrated Development Environment
33 | NoDisplay=false
34 | Categories=Development;IDE;
35 | Name[en]=Eclipse
36 | EOF
37 | sudo mv eclipse.desktop /opt/eclipse/
38 | sudo desktop-file-install /opt/eclipse/eclipse.desktop
39 | sudo cp /opt/eclipse/icon.xpm /usr/share/pixmaps/eclipse.xpm
40 | 


--------------------------------------------------------------------------------
/formatter/eclipse_style.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
  2 | <profiles version="1">
  3 | <profile kind="CodeFormatterProfile" name="Google C++ ASL" version="1">
  4 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_method_declaration" value="do not insert"/>
  5 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_for" value="do not insert"/>
  6 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_in_empty_block" value="insert"/>
  7 | <setting id="org.eclipse.cdt.core.formatter.lineSplit" value="100"/>
  8 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_member_access" value="16"/>
  9 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_base_types" value="do not insert"/>
 10 | <setting id="org.eclipse.cdt.core.formatter.keep_else_statement_on_same_line" value="false"/>
 11 | <setting id="org.eclipse.cdt.core.formatter.indent_switchstatements_compare_to_switch" value="true"/>
 12 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_constructor_initializer_list" value="83"/>
 13 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_brace_in_array_initializer" value="insert"/>
 14 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters" value="do not insert"/>
 15 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_if" value="do not insert"/>
 16 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression" value="do not insert"/>
 17 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_exception_specification" value="do not insert"/>
 18 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_base_types" value="insert"/>
 19 | <setting id="org.eclipse.cdt.core.formatter.indent_body_declarations_compare_to_access_specifier" value="true"/>
 20 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_exception_specification" value="do not insert"/>
 21 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_template_arguments" value="insert"/>
 22 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/>
 23 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_method_declaration" value="do not insert"/>
 24 | <setting id="org.eclipse.cdt.core.formatter.use_tabs_only_for_leading_indentations" value="false"/>
 25 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_colon_in_labeled_statement" value="do not insert"/>
 26 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_colon_in_case" value="insert"/>
 27 | <setting id="org.eclipse.cdt.core.formatter.comment.min_distance_between_code_and_line_comment" value="2"/>
 28 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert"/>
 29 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/>
 30 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_expressions_in_array_initializer" value="16"/>
 31 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_declarator_list" value="insert"/>
 32 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_bracket" value="do not insert"/>
 33 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_for" value="do not insert"/>
 34 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_prefix_operator" value="do not insert"/>
 35 | <setting id="org.eclipse.cdt.core.formatter.tabulation.size" value="2"/>
 36 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_before_else_in_if_statement" value="do not insert"/>
 37 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_enumerator_list" value="51"/>
 38 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression" value="do not insert"/>
 39 | <setting id="org.eclipse.cdt.core.formatter.insert_space_between_empty_parens_in_method_declaration" value="do not insert"/>
 40 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_switch" value="do not insert"/>
 41 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_declarator_list" value="16"/>
 42 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression" value="do not insert"/>
 43 | <setting id="org.eclipse.cdt.core.formatter.indent_empty_lines" value="false"/>
 44 | <setting id="org.eclipse.cdt.core.formatter.indent_switchstatements_compare_to_cases" value="true"/>
 45 | <setting id="org.eclipse.cdt.core.formatter.keep_empty_array_initializer_on_one_line" value="false"/>
 46 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_brace_in_method_declaration" value="insert"/>
 47 | <setting id="org.eclipse.cdt.core.formatter.put_empty_statement_on_new_line" value="true"/>
 48 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_brace_in_switch" value="insert"/>
 49 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_cast" value="do not insert"/>
 50 | <setting id="org.eclipse.cdt.core.formatter.insert_space_between_empty_braces_in_array_initializer" value="do not insert"/>
 51 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_method_declaration" value="next_line"/>
 52 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_while" value="do not insert"/>
 53 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_question_in_conditional" value="insert"/>
 54 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_semicolon" value="do not insert"/>
 55 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_closing_angle_bracket_in_template_arguments" value="insert"/>
 56 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_colon_in_base_clause" value="insert"/>
 57 | <setting id="org.eclipse.cdt.core.formatter.indent_breaks_compare_to_cases" value="true"/>
 58 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_unary_operator" value="do not insert"/>
 59 | <setting id="org.eclipse.cdt.core.formatter.join_wrapped_lines" value="true"/>
 60 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_declarator_list" value="do not insert"/>
 61 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_arguments_in_method_invocation" value="18"/>
 62 | <setting id="org.eclipse.cdt.core.formatter.comment.never_indent_line_comments_on_first_column" value="true"/>
 63 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_while" value="insert"/>
 64 | <setting id="org.eclipse.cdt.core.formatter.insert_space_between_empty_brackets" value="do not insert"/>
 65 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_bracket" value="do not insert"/>
 66 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_parameters_in_method_declaration" value="18"/>
 67 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer" value="do not insert"/>
 68 | <setting id="org.eclipse.cdt.core.formatter.number_of_empty_lines_to_preserve" value="1"/>
 69 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_method_invocation" value="do not insert"/>
 70 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_brace_in_array_initializer" value="insert"/>
 71 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_semicolon_in_for" value="do not insert"/>
 72 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_colon_in_conditional" value="insert"/>
 73 | <setting id="org.eclipse.cdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments" value="true"/>
 74 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_block" value="end_of_line"/>
 75 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_type_declaration" value="next_line"/>
 76 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_assignment_operator" value="insert"/>
 77 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_angle_bracket_in_template_arguments" value="do not insert"/>
 78 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_expression_list" value="do not insert"/>
 79 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_angle_bracket_in_template_parameters" value="do not insert"/>
 80 | <setting id="org.eclipse.cdt.core.formatter.continuation_indentation" value="2"/>
 81 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_expression_list" value="0"/>
 82 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_method_declaration" value="do not insert"/>
 83 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_template_parameters" value="do not insert"/>
 84 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_colon_in_default" value="do not insert"/>
 85 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_binary_operator" value="insert"/>
 86 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_conditional_expression" value="34"/>
 87 | <setting id="org.eclipse.cdt.core.formatter.insert_space_between_empty_parens_in_method_invocation" value="do not insert"/>
 88 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_array_initializer" value="do not insert"/>
 89 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_if" value="do not insert"/>
 90 | <setting id="org.eclipse.cdt.core.formatter.format_guardian_clause_on_one_line" value="false"/>
 91 | <setting id="org.eclipse.cdt.core.formatter.indent_access_specifier_extra_spaces" value="1"/>
 92 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_cast" value="do not insert"/>
 93 | <setting id="org.eclipse.cdt.core.formatter.indent_access_specifier_compare_to_type_header" value="false"/>
 94 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_brace_in_type_declaration" value="insert"/>
 95 | <setting id="org.eclipse.cdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/>
 96 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_colon_in_labeled_statement" value="insert"/>
 97 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters" value="insert"/>
 98 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_semicolon_in_for" value="insert"/>
 99 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_method_invocation" value="do not insert"/>
100 | <setting id="org.eclipse.cdt.core.formatter.indent_body_declarations_compare_to_namespace_header" value="false"/>
101 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_compact_if" value="0"/>
102 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_assignment_operator" value="insert"/>
103 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_closing_brace_in_block" value="insert"/>
104 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_brace_in_array_initializer" value="insert"/>
105 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="do not insert"/>
106 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_assignment" value="16"/>
107 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_conditional_expression_chain" value="18"/>
108 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_template_parameters" value="insert"/>
109 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_expression_list" value="insert"/>
110 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_question_in_conditional" value="insert"/>
111 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_exception_specification" value="insert"/>
112 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_binary_operator" value="insert"/>
113 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_base_clause_in_type_declaration" value="16"/>
114 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_before_identifier_in_function_declaration" value="do not insert"/>
115 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_method_declaration_throws" value="do not insert"/>
116 | <setting id="org.eclipse.cdt.core.formatter.insert_space_between_empty_parens_in_exception_specification" value="do not insert"/>
117 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments" value="do not insert"/>
118 | <setting id="org.eclipse.cdt.core.formatter.indent_declaration_compare_to_template_header" value="false"/>
119 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_unary_operator" value="do not insert"/>
120 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_switch" value="insert"/>
121 | <setting id="org.eclipse.cdt.core.formatter.indent_statements_compare_to_body" value="true"/>
122 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_method_declaration_throws" value="insert"/>
123 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_binary_expression" value="16"/>
124 | <setting id="org.eclipse.cdt.core.formatter.indent_statements_compare_to_block" value="true"/>
125 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_template_arguments" value="do not insert"/>
126 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_before_catch_in_try_statement" value="do not insert"/>
127 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16"/>
128 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_method_invocation" value="do not insert"/>
129 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_paren_in_catch" value="do not insert"/>
130 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_closing_paren_in_cast" value="insert"/>
131 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_angle_bracket_in_template_parameters" value="do not insert"/>
132 | <setting id="org.eclipse.cdt.core.formatter.tabulation.char" value="space"/>
133 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_angle_bracket_in_template_parameters" value="do not insert"/>
134 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_before_colon_in_constructor_initializer_list" value="insert"/>
135 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_while" value="do not insert"/>
136 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert"/>
137 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_block_in_case" value="end_of_line"/>
138 | <setting id="org.eclipse.cdt.core.formatter.compact_else_if" value="true"/>
139 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_postfix_operator" value="do not insert"/>
140 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_after_template_declaration" value="do not insert"/>
141 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_colon_in_base_clause" value="insert"/>
142 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_catch" value="do not insert"/>
143 | <setting id="org.eclipse.cdt.core.formatter.keep_then_statement_on_same_line" value="false"/>
144 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_switch" value="end_of_line"/>
145 | <setting id="org.eclipse.cdt.core.formatter.alignment_for_overloaded_left_shift_chain" value="18"/>
146 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_if" value="insert"/>
147 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_paren_in_switch" value="do not insert"/>
148 | <setting id="org.eclipse.cdt.core.formatter.keep_imple_if_on_one_line" value="false"/>
149 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer" value="do not insert"/>
150 | <setting id="org.eclipse.cdt.core.formatter.indentation.size" value="2"/>
151 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_namespace_declaration" value="end_of_line"/>
152 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_colon_in_conditional" value="insert"/>
153 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_comma_in_enum_declarations" value="do not insert"/>
154 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_prefix_operator" value="do not insert"/>
155 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_angle_bracket_in_template_arguments" value="do not insert"/>
156 | <setting id="org.eclipse.cdt.core.formatter.brace_position_for_array_initializer" value="end_of_line"/>
157 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_colon_in_case" value="do not insert"/>
158 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_catch" value="insert"/>
159 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_brace_in_namespace_declaration" value="insert"/>
160 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_postfix_operator" value="do not insert"/>
161 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_closing_bracket" value="do not insert"/>
162 | <setting id="org.eclipse.cdt.core.formatter.insert_new_line_before_while_in_do_statement" value="do not insert"/>
163 | <setting id="org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_for" value="insert"/>
164 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_closing_angle_bracket_in_template_parameters" value="insert"/>
165 | <setting id="org.eclipse.cdt.core.formatter.insert_space_after_opening_angle_bracket_in_template_arguments" value="do not insert"/>
166 | </profile>
167 | </profiles>
168 | 


--------------------------------------------------------------------------------
/formatter/emacs_style.el:
--------------------------------------------------------------------------------
  1 | ;;; google-c-style.el --- Google's ASL C/C++ style for c-mode
  2 | 
  3 | ;; Keywords: c, tools
  4 | 
  5 | ;; google-c-style.el is Copyright (C) 2008 Google Inc. All Rights Reserved.
  6 | ;;
  7 | ;; It is free software; you can redistribute it and/or modify it under the
  8 | ;; terms of either:
  9 | ;;
 10 | ;; a) the GNU General Public License as published by the Free Software
 11 | ;; Foundation; either version 1, or (at your option) any later version, or
 12 | ;;
 13 | ;; b) the "Artistic License".
 14 | 
 15 | ;;; Commentary:
 16 | 
 17 | ;; Provides the google C/C++ coding style. You may wish to add
 18 | ;; `google-set-c-style' to your `c-mode-common-hook' after requiring this
 19 | ;; file. For example:
 20 | ;;
 21 | ;;    (add-hook 'c-mode-common-hook 'google-set-c-style)
 22 | ;;
 23 | ;; If you want the RETURN key to go to the next line and space over
 24 | ;; to the right place, add this to your .emacs right after the load-file:
 25 | ;;
 26 | ;;    (add-hook 'c-mode-common-hook 'google-make-newline-indent)
 27 | 
 28 | ;;; Code:
 29 | 
 30 | ;; For some reason 1) c-backward-syntactic-ws is a macro and 2)  under Emacs 22
 31 | ;; bytecode cannot call (unexpanded) macros at run time:
 32 | (eval-when-compile (require 'cc-defs))
 33 | 
 34 | ;; Wrapper function needed for Emacs 21 and XEmacs (Emacs 22 offers the more
 35 | ;; elegant solution of composing a list of lineup functions or quantities with
 36 | ;; operators such as "add")
 37 | (defun google-c-lineup-expression-plus-4 (langelem)
 38 |   "Indents to the beginning of the current C expression plus 4 spaces.
 39 | 
 40 | This implements title \"Function Declarations and Definitions\"
 41 | of the Google C++ Style Guide for the case where the previous
 42 | line ends with an open parenthese.
 43 | 
 44 | \"Current C expression\", as per the Google Style Guide and as
 45 | clarified by subsequent discussions, means the whole expression
 46 | regardless of the number of nested parentheses, but excluding
 47 | non-expression material such as \"if(\" and \"for(\" control
 48 | structures.
 49 | 
 50 | Suitable for inclusion in `c-offsets-alist'."
 51 |   (save-excursion
 52 |     (back-to-indentation)
 53 |     ;; Go to beginning of *previous* line:
 54 |     (c-backward-syntactic-ws)
 55 |     (back-to-indentation)
 56 |     (cond
 57 |      ;; We are making a reasonable assumption that if there is a control
 58 |      ;; structure to indent past, it has to be at the beginning of the line.
 59 |      ((looking-at "\\(\\(if\\|for\\|while\\)\\s *(\\)")
 60 |       (goto-char (match-end 1)))
 61 |      ;; For constructor initializer lists, the reference point for line-up is
 62 |      ;; the token after the initial colon.
 63 |      ((looking-at ":\\s *")
 64 |       (goto-char (match-end 0))))
 65 |     (vector (+ 4 (current-column)))))
 66 | 
 67 | (defconst google-c-style
 68 |   `((c-recognize-knr-p . nil)
 69 |     (c-enable-xemacs-performance-kludge-p . t) ; speed up indentation in XEmacs
 70 |     (c-basic-offset . 2)
 71 |     (indent-tabs-mode . nil)
 72 |     (c-comment-only-line-offset . 0)
 73 |     (c-hanging-braces-alist . ((defun-open after)
 74 |                                (defun-close before after)
 75 |                                (class-open after)
 76 |                                (class-close before after)
 77 |                                (inexpr-class-open after)
 78 |                                (inexpr-class-close before)
 79 |                                (namespace-open after)
 80 |                                (inline-open after)
 81 |                                (inline-close before after)
 82 |                                (block-open after)
 83 |                                (block-close . c-snug-do-while)
 84 |                                (extern-lang-open after)
 85 |                                (extern-lang-close after)
 86 |                                (statement-case-open after)
 87 |                                (substatement-open after)))
 88 |     (c-hanging-colons-alist . ((case-label)
 89 |                                (label after)
 90 |                                (access-label after)
 91 |                                (member-init-intro before)
 92 |                                (inher-intro)))
 93 |     (c-hanging-semi&comma-criteria
 94 |      . (c-semi&comma-no-newlines-for-oneline-inliners
 95 |         c-semi&comma-inside-parenlist
 96 |         c-semi&comma-no-newlines-before-nonblanks))
 97 |     (c-indent-comments-syntactically-p . t)
 98 |     (comment-column . 40)
 99 |     (c-indent-comment-alist . ((other . (space . 2))))
100 |     (c-cleanup-list . (brace-else-brace
101 |                        brace-elseif-brace
102 |                        brace-catch-brace
103 |                        empty-defun-braces
104 |                        defun-close-semi
105 |                        list-close-comma
106 |                        scope-operator))
107 |     (c-offsets-alist . ((arglist-intro google-c-lineup-expression-plus-4)
108 |                         (func-decl-cont . ++)
109 |                         (member-init-intro . ++)
110 |                         (inher-intro . ++)
111 |                         (comment-intro . 0)
112 |                         (arglist-close . c-lineup-arglist)
113 |                         (topmost-intro . 0)
114 |                         (block-open . 0)
115 |                         (inline-open . 0)
116 |                         (substatement-open . 0)
117 |                         (statement-cont
118 |                          .
119 |                          (,(when (fboundp 'c-no-indent-after-java-annotations)
120 |                              'c-no-indent-after-java-annotations)
121 |                           ,(when (fboundp 'c-lineup-assignments)
122 |                              'c-lineup-assignments)
123 |                           ++))
124 |                         (label . /)
125 |                         (case-label . +)
126 |                         (statement-case-open . +)
127 |                         (statement-case-intro . +) ; case w/o {
128 |                         (access-label . /)
129 |                         (innamespace . 0))))
130 |   "Google C/C++ Programming Style.")
131 | 
132 | (defun google-set-c-style ()
133 |   "Set the current buffer's c-style to Google C/C++ Programming
134 |   Style. Meant to be added to `c-mode-common-hook'."
135 |   (interactive)
136 |   (make-local-variable 'c-tab-always-indent)
137 |   (setq c-tab-always-indent t)
138 |   (c-add-style "Google" google-c-style t))
139 | 
140 | (defun google-make-newline-indent ()
141 |   "Sets up preferred newline behavior. Not set by default. Meant
142 |   to be added to `c-mode-common-hook'."
143 |   (interactive)
144 |   (define-key c-mode-base-map "\C-m" 'newline-and-indent)
145 |   (define-key c-mode-base-map [ret] 'newline-and-indent))
146 | 
147 | (provide 'google-c-style)
148 | ;;; google-c-style.el ends here
149 | 
150 | 


--------------------------------------------------------------------------------
/wiki/bs_job.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ethz-asl/programming_guidelines/d80ed30e1c70915b67d6078929b9a32ea47d0f45/wiki/bs_job.png


--------------------------------------------------------------------------------
/wiki/bs_overview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ethz-asl/programming_guidelines/d80ed30e1c70915b67d6078929b9a32ea47d0f45/wiki/bs_overview.png


--------------------------------------------------------------------------------
/wiki/build-passed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ethz-asl/programming_guidelines/d80ed30e1c70915b67d6078929b9a32ea47d0f45/wiki/build-passed.png


--------------------------------------------------------------------------------
/wiki/pr-build-server-status.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ethz-asl/programming_guidelines/d80ed30e1c70915b67d6078929b9a32ea47d0f45/wiki/pr-build-server-status.png


--------------------------------------------------------------------------------