├── .gitignore ├── .gitattributes ├── CHANGELOG.md ├── .editorconfig ├── tests ├── test.h ├── test_lock.c ├── test_lock_and_run.c ├── test_wait_timeout.c └── test.c ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── CONTRIBUTING.md └── workflows │ └── ci.yml ├── include └── threadlock.h ├── README.md ├── CMakeLists.txt ├── src └── threadlock.c ├── uncrustify.cfg └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | temp/ 3 | **/*.log 4 | /core 5 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | *.ico binary 3 | *.woff binary 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## CHANGELOG 2 | 3 | ### v0.1.1 (2023-04-19) 4 | 5 | * Prevent non arg functions from accepting args 6 | 7 | ### v0.1.0 (2023-04-19) 8 | 9 | * Initial release 10 | 11 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true 9 | indent_style = space 10 | indent_size = 2 11 | 12 | -------------------------------------------------------------------------------- /tests/test.h: -------------------------------------------------------------------------------- 1 | #ifndef __TEST_H__ 2 | #define __TEST_H__ 3 | 4 | #include 5 | #include 6 | 7 | void test_run(void (*fn)()); 8 | void test_fail(); 9 | void assert_true(bool); 10 | void assert_true_with_description(bool, const char *); 11 | 12 | void assert_size_equal(size_t, size_t); 13 | void assert_num_equal(int, int); 14 | void assert_string_equal(char *, char *); 15 | 16 | #endif 17 | 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Feature Description 11 | 12 | 13 | ### Describe The Solution You'd Like 14 | 15 | 16 | ### Code Sample 17 | 18 | ```c 19 | // paste code here 20 | ``` 21 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Describe The Bug 11 | 12 | 13 | ### To Reproduce 14 | 15 | 16 | ### Error Stack 17 | 18 | ```console 19 | The error stack trace 20 | ``` 21 | 22 | ### Code Sample 23 | 24 | ```c 25 | // paste code here 26 | ``` 27 | -------------------------------------------------------------------------------- /tests/test_lock.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadlock.h" 3 | 4 | 5 | static void test_impl() 6 | { 7 | struct ThreadLock *lock = threadlock_new(); 8 | 9 | bool done = threadlock_lock(lock); 10 | 11 | assert_true_with_description(done, "failed to lock"); 12 | done = threadlock_unlock(lock); 13 | assert_true_with_description(done, "failed to unlock"); 14 | 15 | threadlock_release(lock); 16 | } 17 | 18 | 19 | int main() 20 | { 21 | test_run(test_impl); 22 | } 23 | 24 | -------------------------------------------------------------------------------- /tests/test_lock_and_run.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadlock.h" 3 | 4 | static bool _global_invoked = false; 5 | 6 | 7 | static void *_test_run(void *args) 8 | { 9 | assert_string_equal((char *)args, "test"); 10 | _global_invoked = true; 11 | return("output"); 12 | } 13 | 14 | 15 | static void test_impl() 16 | { 17 | struct ThreadLock *lock = threadlock_new(); 18 | 19 | void *output = threadlock_lock_and_run(lock, _test_run, "test"); 20 | 21 | assert_string_equal((char *)output, "output"); 22 | 23 | threadlock_release(lock); 24 | } 25 | 26 | 27 | int main() 28 | { 29 | test_run(test_impl); 30 | } 31 | 32 | -------------------------------------------------------------------------------- /tests/test_wait_timeout.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include "threadlock.h" 3 | #include 4 | 5 | 6 | static void test_impl() 7 | { 8 | struct ThreadLockOptions options = threadlock_new_default_options(); 9 | 10 | options.wait_timeout_in_milliseconds = 3000; 11 | struct ThreadLock *lock = threadlock_new_with_options(options); 12 | 13 | time_t start = time(NULL); 14 | bool done = threadlock_wait(lock, true); 15 | time_t wait_time = time(NULL) - start; 16 | assert_true_with_description(done, "failed to wait"); 17 | assert_true_with_description(wait_time > 1, "timeout was too short"); 18 | 19 | threadlock_release(lock); 20 | } 21 | 22 | 23 | int main() 24 | { 25 | test_run(test_impl); 26 | } 27 | 28 | -------------------------------------------------------------------------------- /include/threadlock.h: -------------------------------------------------------------------------------- 1 | #ifndef THREADLOCK_H 2 | #define THREADLOCK_H 3 | 4 | #include 5 | #include 6 | 7 | struct ThreadLock; 8 | 9 | struct ThreadLockOptions 10 | { 11 | int wait_timeout_in_milliseconds; 12 | }; 13 | 14 | struct ThreadLockOptions threadlock_new_default_options(void); 15 | struct ThreadLock *threadlock_new(void); 16 | struct ThreadLock *threadlock_new_with_options(struct ThreadLockOptions); 17 | void threadlock_release(struct ThreadLock *); 18 | bool threadlock_lock(struct ThreadLock *); 19 | bool threadlock_unlock(struct ThreadLock *); 20 | bool threadlock_signal(struct ThreadLock *, bool wrap_with_lock); 21 | bool threadlock_wait(struct ThreadLock *, bool wrap_with_lock); 22 | bool threadlock_wait_with_timeout(struct ThreadLock *, bool wrap_with_lock, int wait_timeout_in_milliseconds); 23 | void *threadlock_lock_and_run(struct ThreadLock *, void * (*fn)(void *), void *); 24 | 25 | #endif 26 | 27 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | ## Issues 4 | 5 | Found a bug? Got a question? Want some enhancement?
6 | First place to go is the repository issues section, and I'll try to help as much as possible. 7 | 8 | ## Pull Requests 9 | 10 | Fixed a bug or just want to provided additional functionality?
11 | Simply fork this repository, implement your changes and create a pull request.
12 | Few guidelines regarding pull requests: 13 | 14 | * This repository is integrated with github actions for continuous integration.
15 | 16 | Your pull request build must pass (the build will run automatically).
17 | You can run the following command locally to ensure the build will pass: 18 | 19 | ```sh 20 | mkdir ./target 21 | cd ./target 22 | cmake .. 23 | make 24 | ctest -C Release --output-on-failure 25 | ``` 26 | 27 | * There are many automatic unit tests as part of the library which provide full coverage of the functionality.
Any fix/enhancement must come with a set of tests to ensure it's working well. 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Thread Lock 2 | 3 | [![CI](https://github.com/sagiegurari/c_thread_lock/workflows/CI/badge.svg?branch=master)](https://github.com/sagiegurari/c_thread_lock/actions) 4 | [![Release](https://img.shields.io/github/v/release/sagiegurari/c_thread_lock)](https://github.com/sagiegurari/c_thread_lock/releases) 5 | [![license](https://img.shields.io/github/license/sagiegurari/c_thread_lock)](https://github.com/sagiegurari/c_thread_lock/blob/master/LICENSE) 6 | 7 | > Simple Thread Lock/Signal API for C. 8 | 9 | * [Overview](#overview) 10 | * [Contributing](.github/CONTRIBUTING.md) 11 | * [Release History](CHANGELOG.md) 12 | * [License](#license) 13 | 14 | 15 | ## Overview 16 | This library provides a simple thread lock/unlock signal/wait API for C. 17 | 18 | ## Contributing 19 | See [contributing guide](.github/CONTRIBUTING.md) 20 | 21 | 22 | ## Release History 23 | 24 | See [Changelog](CHANGELOG.md) 25 | 26 | 27 | ## License 28 | Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license. 29 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: [push, pull_request] 3 | env: 4 | BUILD_TYPE: Release 5 | jobs: 6 | ci: 7 | name: CI 8 | runs-on: ${{ matrix.os }} 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | os: [ubuntu-latest, macOS-latest] 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | - name: Setup Env 17 | run: cmake -E make_directory target 18 | - name: Configure 19 | shell: bash 20 | working-directory: target 21 | run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE 22 | - name: Build 23 | shell: bash 24 | working-directory: target 25 | run: cmake --build . --config $BUILD_TYPE 26 | - name: Test 27 | shell: bash 28 | working-directory: target 29 | run: ctest -C $BUILD_TYPE --output-on-failure 30 | - name: Memory Leak Test 31 | if: matrix.os == 'ubuntu-latest' 32 | shell: bash 33 | working-directory: target 34 | run: | 35 | sudo apt update 36 | sudo apt install -y valgrind --fix-missing 37 | for testfile in ./bin/test_*; do echo "Testing ${testfile}" && valgrind --leak-check=full --show-leak-kinds=definite,indirect,possible --error-exitcode=1 "${testfile}"; done 38 | 39 | -------------------------------------------------------------------------------- /tests/test.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include 3 | #include 4 | #include 5 | 6 | 7 | void test_run(void (*fn)(void)) 8 | { 9 | printf("Test ... "); 10 | fn(); 11 | printf("Done\n"); 12 | } 13 | 14 | 15 | void test_fail() 16 | { 17 | printf(" Error\n"); 18 | exit(1); 19 | } 20 | 21 | 22 | void assert_true(bool value) 23 | { 24 | assert_true_with_description(value, NULL); 25 | } 26 | 27 | 28 | void assert_true_with_description(bool value, const char *message) 29 | { 30 | if (!value) 31 | { 32 | if (message != NULL) 33 | { 34 | printf("\n%s\n", message); 35 | } 36 | test_fail(); 37 | } 38 | } 39 | 40 | 41 | void assert_size_equal(size_t value1, size_t value2) 42 | { 43 | if (value1 != value2) 44 | { 45 | #ifdef linux 46 | printf("Assert Failed, value: %zu not equals to value: %zu", value1, value2); 47 | #endif 48 | test_fail(); 49 | } 50 | } 51 | 52 | 53 | void assert_num_equal(int value1, int value2) 54 | { 55 | if (value1 != value2) 56 | { 57 | #ifdef linux 58 | printf("Assert Failed, value: %d not equals to value: %d", value1, value2); 59 | #endif 60 | test_fail(); 61 | } 62 | } 63 | 64 | 65 | void assert_string_equal(char *value1, char *value2) 66 | { 67 | if (strcmp(value1, value2) != 0) 68 | { 69 | printf("Assert Failed, value: %s not equals to value: %s", value1, value2); 70 | test_fail(); 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | 2 | cmake_minimum_required(VERSION 3.7) 3 | 4 | project(threadlock C) 5 | 6 | # include shared utilities 7 | if(NOT EXISTS "target/cmake-modules/src/utils.cmake") 8 | execute_process(COMMAND git clone https://github.com/sagiegurari/cmake-modules.git) 9 | endif() 10 | include("target/cmake-modules/src/utils.cmake") 11 | 12 | set(CMAKE_EXPORT_COMPILE_COMMANDS ON) 13 | 14 | set(CMAKE_BUILD_TYPE Release) 15 | set(CMAKE_C_FLAGS -pthread) 16 | if(NOT WIN32) 17 | set(X_CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror -Wall -Wextra -Wcast-align -Wunused -Wshadow -Wpedantic") 18 | endif() 19 | 20 | set(X_CMAKE_PROJECT_ROOT_DIR ${CMAKE_BINARY_DIR}/..) 21 | 22 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 23 | set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 24 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 25 | 26 | include_directories(include) 27 | 28 | # define all sources 29 | file(GLOB SOURCES "src/*.c") 30 | file(GLOB HEADER_SOURCES "include/*.h") 31 | file(GLOB TEST_SOURCES "tests/*") 32 | file(GLOB COMMON_TEST_SOURCES "tests/test.*") 33 | 34 | # lint code 35 | utils_cppcheck(INCLUDE_DIRECTORY "./include/" SOURCES "./src/*.c" WORKING_DIRECTORY "${X_CMAKE_PROJECT_ROOT_DIR}") 36 | 37 | # format code 38 | utils_uncrustify( 39 | CONFIG_FILE "${X_CMAKE_PROJECT_ROOT_DIR}/uncrustify.cfg" 40 | SOURCES ${SOURCES} ${HEADER_SOURCES} ${TEST_SOURCES} 41 | ) 42 | 43 | # create static library 44 | add_library(${CMAKE_PROJECT_NAME} STATIC ${SOURCES}) 45 | if(NOT WIN32) 46 | set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS} -Wconversion") 47 | endif() 48 | 49 | # tests 50 | include(CTest) 51 | 52 | utils_setup_test_lib( 53 | SOURCES "${COMMON_TEST_SOURCES}" 54 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 55 | ) 56 | utils_setup_c_all_tests( 57 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 58 | BINARY_DIRECTORY "${CMAKE_BINARY_DIR}/bin" 59 | LIBRARIES "Test" 60 | ) 61 | 62 | -------------------------------------------------------------------------------- /src/threadlock.c: -------------------------------------------------------------------------------- 1 | #include "threadlock.h" 2 | #include 3 | #include 4 | 5 | struct ThreadLock 6 | { 7 | int wait_timeout_in_milliseconds; 8 | pthread_mutex_t lock; 9 | pthread_cond_t signal; 10 | }; 11 | 12 | struct ThreadLockOptions threadlock_new_default_options(void) 13 | { 14 | struct ThreadLockOptions options = 15 | { 16 | .wait_timeout_in_milliseconds = 0, 17 | }; 18 | 19 | return(options); 20 | } 21 | 22 | struct ThreadLock *threadlock_new(void) 23 | { 24 | struct ThreadLockOptions options = threadlock_new_default_options(); 25 | 26 | return(threadlock_new_with_options(options)); 27 | } 28 | 29 | struct ThreadLock *threadlock_new_with_options(struct ThreadLockOptions options) 30 | { 31 | struct ThreadLock *lock = malloc(sizeof(struct ThreadLock)); 32 | 33 | lock->wait_timeout_in_milliseconds = options.wait_timeout_in_milliseconds; 34 | 35 | if (pthread_mutex_init(&lock->lock, NULL)) 36 | { 37 | free(lock); 38 | return(NULL); 39 | } 40 | if (pthread_cond_init(&lock->signal, NULL)) 41 | { 42 | pthread_mutex_destroy(&lock->lock); 43 | free(lock); 44 | return(NULL); 45 | } 46 | 47 | return(lock); 48 | } 49 | 50 | 51 | void threadlock_release(struct ThreadLock *lock) 52 | { 53 | if (lock == NULL) 54 | { 55 | return; 56 | } 57 | 58 | pthread_mutex_destroy(&lock->lock); 59 | pthread_cond_destroy(&lock->signal); 60 | free(lock); 61 | } 62 | 63 | 64 | bool threadlock_lock(struct ThreadLock *lock) 65 | { 66 | if (lock == NULL) 67 | { 68 | return(false); 69 | } 70 | 71 | pthread_mutex_lock(&lock->lock); 72 | return(true); 73 | } 74 | 75 | 76 | bool threadlock_unlock(struct ThreadLock *lock) 77 | { 78 | if (lock == NULL) 79 | { 80 | return(false); 81 | } 82 | 83 | pthread_mutex_unlock(&lock->lock); 84 | return(true); 85 | } 86 | 87 | 88 | bool threadlock_signal(struct ThreadLock *lock, bool wrap_with_lock) 89 | { 90 | if (lock == NULL) 91 | { 92 | return(false); 93 | } 94 | 95 | if (wrap_with_lock) 96 | { 97 | if (!threadlock_lock(lock)) 98 | { 99 | return(false); 100 | } 101 | } 102 | 103 | pthread_cond_signal(&lock->signal); 104 | 105 | if (wrap_with_lock) 106 | { 107 | threadlock_unlock(lock); 108 | } 109 | 110 | return(true); 111 | } 112 | 113 | 114 | bool threadlock_wait(struct ThreadLock *lock, bool wrap_with_lock) 115 | { 116 | if (lock == NULL) 117 | { 118 | return(false); 119 | } 120 | 121 | return(threadlock_wait_with_timeout(lock, wrap_with_lock, lock->wait_timeout_in_milliseconds)); 122 | } 123 | 124 | 125 | bool threadlock_wait_with_timeout(struct ThreadLock *lock, bool wrap_with_lock, int wait_timeout_in_milliseconds) 126 | { 127 | if (lock == NULL) 128 | { 129 | return(false); 130 | } 131 | 132 | if (wrap_with_lock) 133 | { 134 | if (!threadlock_lock(lock)) 135 | { 136 | return(false); 137 | } 138 | } 139 | 140 | if (wait_timeout_in_milliseconds <= 0) 141 | { 142 | pthread_cond_wait(&lock->signal, &lock->lock); 143 | } 144 | else 145 | { 146 | int seconds = wait_timeout_in_milliseconds / 1000; 147 | int nano_seconds = (wait_timeout_in_milliseconds - seconds * 1000) * 1000000; 148 | 149 | struct timespec ts; 150 | ts.tv_sec = time(NULL) + seconds; 151 | ts.tv_nsec = nano_seconds; 152 | pthread_cond_timedwait(&lock->signal, &lock->lock, &ts); 153 | } 154 | 155 | if (wrap_with_lock) 156 | { 157 | threadlock_unlock(lock); 158 | } 159 | 160 | return(true); 161 | } 162 | 163 | 164 | void *threadlock_lock_and_run(struct ThreadLock *lock, void * (*fn)(void *), void *args) 165 | { 166 | if (lock == NULL) 167 | { 168 | return(NULL); 169 | } 170 | 171 | if (!threadlock_lock(lock)) 172 | { 173 | return(NULL); 174 | } 175 | 176 | void *output = fn(args); 177 | 178 | threadlock_unlock(lock); 179 | 180 | return(output); 181 | } 182 | 183 | -------------------------------------------------------------------------------- /uncrustify.cfg: -------------------------------------------------------------------------------- 1 | output_tab_size = 2 2 | tok_split_gte = true 3 | indent_columns = 2 4 | indent_with_tabs = 0 5 | indent_class = true 6 | indent_member = 2 7 | indent_bool_paren = true 8 | indent_first_bool_expr = true 9 | sp_arith = force 10 | sp_assign = force 11 | sp_assign_default = force 12 | sp_bool = force 13 | sp_compare = force 14 | sp_inside_paren = remove 15 | sp_paren_paren = remove 16 | sp_before_ptr_star = force 17 | sp_between_ptr_star = remove 18 | sp_after_ptr_star = remove 19 | sp_before_byref = force 20 | sp_after_byref = remove 21 | sp_before_angle = remove 22 | sp_inside_angle = remove 23 | sp_after_angle = force 24 | sp_angle_paren = remove 25 | sp_angle_paren_empty = remove 26 | sp_angle_word = force 27 | sp_before_sparen = force 28 | sp_inside_sparen = remove 29 | sp_after_sparen = force 30 | sp_before_semi_for = remove 31 | sp_before_semi_for_empty = force 32 | sp_before_squares = remove 33 | sp_inside_square = remove 34 | sp_after_comma = force 35 | sp_before_ellipsis = remove 36 | sp_after_cast = remove 37 | sp_sizeof_paren = remove 38 | sp_inside_braces_enum = force 39 | sp_inside_braces_struct = force 40 | sp_inside_braces = force 41 | sp_func_proto_paren = remove 42 | sp_func_def_paren = remove 43 | sp_inside_fparen = remove 44 | sp_after_tparen_close = remove 45 | sp_func_call_paren = remove 46 | sp_return_paren = remove 47 | sp_attribute_paren = remove 48 | sp_defined_paren = force 49 | sp_brace_typedef = force 50 | sp_before_dc = remove 51 | sp_after_dc = remove 52 | sp_enum_assign = force 53 | align_func_params = true 54 | align_var_def_span = 2 55 | align_var_def_star_style = 1 56 | align_var_def_amp_style = 1 57 | align_var_def_colon = true 58 | align_var_def_inline = true 59 | align_assign_span = 1 60 | align_enum_equ_span = 4 61 | align_var_class_span = 2 62 | align_var_struct_span = 3 63 | align_struct_init_span = 3 64 | align_typedef_gap = 3 65 | align_typedef_span = 5 66 | align_typedef_star_style = 1 67 | align_right_cmt_span = 3 68 | align_nl_cont = true 69 | align_pp_define_gap = 4 70 | align_pp_define_span = 3 71 | align_asm_colon = true 72 | align_enum_equ_thresh = 8 73 | nl_assign_leave_one_liners = true 74 | nl_class_leave_one_liners = true 75 | nl_enum_leave_one_liners = true 76 | nl_getset_leave_one_liners = true 77 | nl_assign_brace = add 78 | nl_func_var_def_blk = 1 79 | nl_fcall_brace = add 80 | nl_enum_brace = force 81 | nl_struct_brace = add 82 | nl_union_brace = add 83 | nl_if_brace = add 84 | nl_brace_else = add 85 | nl_elseif_brace = add 86 | nl_else_brace = add 87 | nl_finally_brace = add 88 | nl_try_brace = add 89 | nl_for_brace = add 90 | nl_catch_brace = add 91 | nl_while_brace = add 92 | nl_do_brace = add 93 | nl_brace_while = remove 94 | nl_switch_brace = add 95 | nl_before_case = true 96 | nl_after_case = true 97 | nl_case_colon_brace = force 98 | nl_namespace_brace = force 99 | nl_constr_init_args = force 100 | nl_func_type_name = remove 101 | nl_func_paren = remove 102 | nl_func_def_paren = remove 103 | nl_func_decl_start = remove 104 | nl_func_def_start = remove 105 | nl_func_decl_start_single = remove 106 | nl_func_def_start_single = remove 107 | nl_func_decl_args = remove 108 | nl_func_decl_end = remove 109 | nl_func_def_end = remove 110 | nl_func_decl_end_single = remove 111 | nl_func_def_end_single = remove 112 | nl_fdef_brace = force 113 | nl_return_expr = remove 114 | nl_after_semicolon = true 115 | nl_after_brace_open = true 116 | nl_after_vbrace_open = true 117 | nl_after_brace_close = true 118 | nl_squeeze_ifdef = true 119 | nl_constr_colon = force 120 | pos_constr_comma = lead_force 121 | pos_constr_colon = lead_break 122 | pos_bool = lead 123 | pos_enum_comma = trail_force 124 | nl_max = 3 125 | nl_after_func_proto = 1 126 | nl_after_func_proto_group = 2 127 | nl_before_func_body_def = 3 128 | nl_after_access_spec = 1 129 | eat_blanks_after_open_brace = true 130 | eat_blanks_before_close_brace = true 131 | nl_after_return = true 132 | mod_full_brace_do = add 133 | mod_full_brace_for = add 134 | mod_full_brace_if = add 135 | mod_full_brace_while = add 136 | mod_paren_on_return = add 137 | mod_remove_extra_semicolon = true 138 | mod_add_long_function_closebrace_comment = 40 139 | mod_add_long_namespace_closebrace_comment = 5 140 | mod_add_long_switch_closebrace_comment = 40 141 | mod_remove_empty_return = true 142 | cmt_star_cont = true 143 | pp_indent = remove 144 | pp_space = remove 145 | mod_sort_include = true 146 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------