From 63fa733fd8939c901f91724891f0467a46f857dc Mon Sep 17 00:00:00 2001 From: Federica Di Lauro Date: Thu, 19 Sep 2019 13:25:24 +0200 Subject: [PATCH] add c++ style guide --- README.md | 5 ++ .../.settings/org.eclipse.cdt.core.prefs | 36 +++++------ .../.settings/org.eclipse.cdt.ui.prefs | 2 +- otto_controller_source/Src/main.cpp | 60 +++++++++---------- 4 files changed, 51 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 5fe22a1..b8f739f 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,8 @@ Material regarding my stage with Iralab, designing and realizing a 2 wheeled robot See the [wiki](https://github.com/iralabdisco/otto/wiki) for more info about this projects + +Follow [Google C++ guideline](https://github.com/google/styleguide) while working on the project + +Eclipse's formatting configuration file can be found [here](https://github.com/google/styleguide/blob/gh-pages/eclipse-cpp-google-style.xml) + diff --git a/otto_controller_source/.settings/org.eclipse.cdt.core.prefs b/otto_controller_source/.settings/org.eclipse.cdt.core.prefs index f2d6512..cfb80d5 100644 --- a/otto_controller_source/.settings/org.eclipse.cdt.core.prefs +++ b/otto_controller_source/.settings/org.eclipse.cdt.core.prefs @@ -1,18 +1,18 @@ eclipse.preferences.version=1 org.eclipse.cdt.core.formatter.alignment_for_arguments_in_method_invocation=18 org.eclipse.cdt.core.formatter.alignment_for_assignment=16 -org.eclipse.cdt.core.formatter.alignment_for_base_clause_in_type_declaration=80 +org.eclipse.cdt.core.formatter.alignment_for_base_clause_in_type_declaration=16 org.eclipse.cdt.core.formatter.alignment_for_binary_expression=16 -org.eclipse.cdt.core.formatter.alignment_for_compact_if=16 +org.eclipse.cdt.core.formatter.alignment_for_compact_if=0 org.eclipse.cdt.core.formatter.alignment_for_conditional_expression=34 org.eclipse.cdt.core.formatter.alignment_for_conditional_expression_chain=18 -org.eclipse.cdt.core.formatter.alignment_for_constructor_initializer_list=0 +org.eclipse.cdt.core.formatter.alignment_for_constructor_initializer_list=83 org.eclipse.cdt.core.formatter.alignment_for_declarator_list=16 -org.eclipse.cdt.core.formatter.alignment_for_enumerator_list=48 +org.eclipse.cdt.core.formatter.alignment_for_enumerator_list=51 org.eclipse.cdt.core.formatter.alignment_for_expression_list=0 org.eclipse.cdt.core.formatter.alignment_for_expressions_in_array_initializer=16 -org.eclipse.cdt.core.formatter.alignment_for_member_access=0 -org.eclipse.cdt.core.formatter.alignment_for_overloaded_left_shift_chain=16 +org.eclipse.cdt.core.formatter.alignment_for_member_access=16 +org.eclipse.cdt.core.formatter.alignment_for_overloaded_left_shift_chain=18 org.eclipse.cdt.core.formatter.alignment_for_parameters_in_method_declaration=18 org.eclipse.cdt.core.formatter.alignment_for_throws_clause_in_method_declaration=16 org.eclipse.cdt.core.formatter.brace_position_for_array_initializer=end_of_line @@ -23,7 +23,7 @@ org.eclipse.cdt.core.formatter.brace_position_for_namespace_declaration=end_of_l org.eclipse.cdt.core.formatter.brace_position_for_switch=end_of_line org.eclipse.cdt.core.formatter.brace_position_for_type_declaration=end_of_line org.eclipse.cdt.core.formatter.comment.line_up_line_comment_in_blocks_on_first_column=false -org.eclipse.cdt.core.formatter.comment.min_distance_between_code_and_line_comment=1 +org.eclipse.cdt.core.formatter.comment.min_distance_between_code_and_line_comment=2 org.eclipse.cdt.core.formatter.comment.never_indent_line_comments_on_first_column=true org.eclipse.cdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments=true org.eclipse.cdt.core.formatter.comment_formatter_off_tag=@formatter\:off @@ -33,11 +33,11 @@ org.eclipse.cdt.core.formatter.continuation_indentation=2 org.eclipse.cdt.core.formatter.continuation_indentation_for_array_initializer=2 org.eclipse.cdt.core.formatter.format_guardian_clause_on_one_line=false org.eclipse.cdt.core.formatter.indent_access_specifier_compare_to_type_header=false -org.eclipse.cdt.core.formatter.indent_access_specifier_extra_spaces=0 +org.eclipse.cdt.core.formatter.indent_access_specifier_extra_spaces=1 org.eclipse.cdt.core.formatter.indent_body_declarations_compare_to_access_specifier=true -org.eclipse.cdt.core.formatter.indent_body_declarations_compare_to_namespace_header=true +org.eclipse.cdt.core.formatter.indent_body_declarations_compare_to_namespace_header=false org.eclipse.cdt.core.formatter.indent_breaks_compare_to_cases=true -org.eclipse.cdt.core.formatter.indent_declaration_compare_to_template_header=true +org.eclipse.cdt.core.formatter.indent_declaration_compare_to_template_header=false org.eclipse.cdt.core.formatter.indent_empty_lines=false org.eclipse.cdt.core.formatter.indent_statements_compare_to_block=true org.eclipse.cdt.core.formatter.indent_statements_compare_to_body=true @@ -45,14 +45,14 @@ org.eclipse.cdt.core.formatter.indent_switchstatements_compare_to_cases=true org.eclipse.cdt.core.formatter.indent_switchstatements_compare_to_switch=true org.eclipse.cdt.core.formatter.indentation.size=2 org.eclipse.cdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer=do not insert -org.eclipse.cdt.core.formatter.insert_new_line_after_template_declaration=insert +org.eclipse.cdt.core.formatter.insert_new_line_after_template_declaration=do not insert org.eclipse.cdt.core.formatter.insert_new_line_at_end_of_file_if_missing=do not insert -org.eclipse.cdt.core.formatter.insert_new_line_before_catch_in_try_statement=insert +org.eclipse.cdt.core.formatter.insert_new_line_before_catch_in_try_statement=do not insert org.eclipse.cdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer=do not insert -org.eclipse.cdt.core.formatter.insert_new_line_before_colon_in_constructor_initializer_list=do not insert -org.eclipse.cdt.core.formatter.insert_new_line_before_else_in_if_statement=insert -org.eclipse.cdt.core.formatter.insert_new_line_before_identifier_in_function_declaration=insert -org.eclipse.cdt.core.formatter.insert_new_line_before_while_in_do_statement=insert +org.eclipse.cdt.core.formatter.insert_new_line_before_colon_in_constructor_initializer_list=insert +org.eclipse.cdt.core.formatter.insert_new_line_before_else_in_if_statement=do not insert +org.eclipse.cdt.core.formatter.insert_new_line_before_identifier_in_function_declaration=do not insert +org.eclipse.cdt.core.formatter.insert_new_line_before_while_in_do_statement=do not insert org.eclipse.cdt.core.formatter.insert_new_line_in_empty_block=insert org.eclipse.cdt.core.formatter.insert_space_after_assignment_operator=insert org.eclipse.cdt.core.formatter.insert_space_after_binary_operator=insert @@ -137,8 +137,8 @@ org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_catch=insert org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_exception_specification=insert org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_for=insert org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_if=insert -org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_method_declaration=insert -org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_method_invocation=insert +org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_method_declaration=do not insert +org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_method_invocation=do not insert org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression=do not insert org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_switch=insert org.eclipse.cdt.core.formatter.insert_space_before_opening_paren_in_while=insert diff --git a/otto_controller_source/.settings/org.eclipse.cdt.ui.prefs b/otto_controller_source/.settings/org.eclipse.cdt.ui.prefs index a16bf7d..d5d8076 100644 --- a/otto_controller_source/.settings/org.eclipse.cdt.ui.prefs +++ b/otto_controller_source/.settings/org.eclipse.cdt.ui.prefs @@ -1,3 +1,3 @@ eclipse.preferences.version=1 -formatter_profile=_GoogleC++ +formatter_profile=_Google C++ formatter_settings_version=1 diff --git a/otto_controller_source/Src/main.cpp b/otto_controller_source/Src/main.cpp index 4f03abf..35512fa 100644 --- a/otto_controller_source/Src/main.cpp +++ b/otto_controller_source/Src/main.cpp @@ -53,13 +53,13 @@ DMA_HandleTypeDef hdma_usart3_tx; /* Private function prototypes -----------------------------------------------*/ void -SystemClock_Config (void); +SystemClock_Config(void); static void -MX_GPIO_Init (void); +MX_GPIO_Init(void); static void -MX_DMA_Init (void); +MX_DMA_Init(void); static void -MX_USART3_UART_Init (void); +MX_USART3_UART_Init(void); /* USER CODE BEGIN PFP */ /* USER CODE END PFP */ @@ -73,8 +73,7 @@ MX_USART3_UART_Init (void); * @brief The application entry point. * @retval int */ -int -main (void) { +int main(void) { /* USER CODE BEGIN 1 */ /* USER CODE END 1 */ @@ -82,23 +81,23 @@ main (void) { /* MCU Configuration--------------------------------------------------------*/ /* Reset of all peripherals, Initializes the Flash interface and the Systick. */ - HAL_Init (); + HAL_Init(); /* USER CODE BEGIN Init */ /* USER CODE END Init */ /* Configure the system clock */ - SystemClock_Config (); + SystemClock_Config(); /* USER CODE BEGIN SysInit */ /* USER CODE END SysInit */ /* Initialize all configured peripherals */ - MX_GPIO_Init (); - MX_DMA_Init (); - MX_USART3_UART_Init (); + MX_GPIO_Init(); + MX_DMA_Init(); + MX_USART3_UART_Init(); /* USER CODE BEGIN 2 */ /* USER CODE END 2 */ @@ -117,8 +116,7 @@ main (void) { * @brief System Clock Configuration * @retval None */ -void -SystemClock_Config (void) { +void SystemClock_Config(void) { RCC_OscInitTypeDef RCC_OscInitStruct = { 0 }; RCC_ClkInitTypeDef RCC_ClkInitStruct = { 0 }; RCC_PeriphCLKInitTypeDef PeriphClkInitStruct = { 0 }; @@ -134,8 +132,8 @@ SystemClock_Config (void) { RCC_OscInitStruct.HSIState = RCC_HSI_ON; RCC_OscInitStruct.HSICalibrationValue = RCC_HSICALIBRATION_DEFAULT; RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE; - if (HAL_RCC_OscConfig (&RCC_OscInitStruct) != HAL_OK) { - Error_Handler (); + if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) { + Error_Handler(); } /** Initializes the CPU, AHB and APB busses clocks */ @@ -146,13 +144,13 @@ SystemClock_Config (void) { RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV1; RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1; - if (HAL_RCC_ClockConfig (&RCC_ClkInitStruct, FLASH_LATENCY_0) != HAL_OK) { - Error_Handler (); + if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_0) != HAL_OK) { + Error_Handler(); } PeriphClkInitStruct.PeriphClockSelection = RCC_PERIPHCLK_USART3; PeriphClkInitStruct.Usart3ClockSelection = RCC_USART3CLKSOURCE_PCLK1; - if (HAL_RCCEx_PeriphCLKConfig (&PeriphClkInitStruct) != HAL_OK) { - Error_Handler (); + if (HAL_RCCEx_PeriphCLKConfig(&PeriphClkInitStruct) != HAL_OK) { + Error_Handler(); } } @@ -161,8 +159,7 @@ SystemClock_Config (void) { * @param None * @retval None */ -static void -MX_USART3_UART_Init (void) { +static void MX_USART3_UART_Init(void) { /* USER CODE BEGIN USART3_Init 0 */ @@ -181,8 +178,8 @@ MX_USART3_UART_Init (void) { huart3.Init.OverSampling = UART_OVERSAMPLING_16; huart3.Init.OneBitSampling = UART_ONE_BIT_SAMPLE_DISABLE; huart3.AdvancedInit.AdvFeatureInit = UART_ADVFEATURE_NO_INIT; - if (HAL_UART_Init (&huart3) != HAL_OK) { - Error_Handler (); + if (HAL_UART_Init(&huart3) != HAL_OK) { + Error_Handler(); } /* USER CODE BEGIN USART3_Init 2 */ @@ -193,8 +190,7 @@ MX_USART3_UART_Init (void) { /** * Enable DMA controller clock */ -static void -MX_DMA_Init (void) { +static void MX_DMA_Init(void) { /* DMA controller clock enable */ __HAL_RCC_DMA1_CLK_ENABLE() @@ -202,11 +198,11 @@ MX_DMA_Init (void) { /* DMA interrupt init */ /* DMA1_Stream1_IRQn interrupt configuration */ - HAL_NVIC_SetPriority (DMA1_Stream1_IRQn, 0, 0); - HAL_NVIC_EnableIRQ (DMA1_Stream1_IRQn); + HAL_NVIC_SetPriority(DMA1_Stream1_IRQn, 0, 0); + HAL_NVIC_EnableIRQ(DMA1_Stream1_IRQn); /* DMA1_Stream3_IRQn interrupt configuration */ - HAL_NVIC_SetPriority (DMA1_Stream3_IRQn, 0, 0); - HAL_NVIC_EnableIRQ (DMA1_Stream3_IRQn); + HAL_NVIC_SetPriority(DMA1_Stream3_IRQn, 0, 0); + HAL_NVIC_EnableIRQ(DMA1_Stream3_IRQn); } @@ -215,8 +211,7 @@ MX_DMA_Init (void) { * @param None * @retval None */ -static void -MX_GPIO_Init (void) { +static void MX_GPIO_Init(void) { /* GPIO Ports Clock Enable */ __HAL_RCC_GPIOD_CLK_ENABLE() @@ -232,8 +227,7 @@ MX_GPIO_Init (void) { * @brief This function is executed in case of error occurrence. * @retval None */ -void -Error_Handler (void) { +void Error_Handler(void) { /* USER CODE BEGIN Error_Handler_Debug */ /* User can add his own implementation to report the HAL error return state */ -- 2.52.0