├── .gitignore ├── .gitattributes ├── .editorconfig ├── post-example-build.cmake ├── tests ├── test_parse_string_null_string.c ├── test_parse_string_invalid_section.c ├── test.h ├── test_parse_string_empty_string.c ├── test_new_specification.c ├── test_parse_string_simple.c ├── test_parse_string_custom_specification.c ├── test.c └── test_parse_string_complex.c ├── CHANGELOG.md ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── CONTRIBUTING.md └── workflows │ ├── ci.yml │ └── codeql-analysis.yml ├── examples └── example.c ├── include └── ini.h ├── README.md ├── CMakeLists.txt ├── uncrustify.cfg ├── src └── ini.c └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | temp/ 3 | **/*.log 4 | /core 5 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | *.ico binary 3 | *.woff binary 4 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /post-example-build.cmake: -------------------------------------------------------------------------------- 1 | 2 | include("./cmake-modules/src/utils.cmake") 3 | 4 | utils_embed_example_source_in_readme( 5 | EXAMPLE_FILE "../examples/example.c" 6 | DOCUMENT_FILE "../README.md" 7 | SOURCE_TYPE "c" 8 | ) 9 | 10 | -------------------------------------------------------------------------------- /tests/test_parse_string_null_string.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | 4 | 5 | void test_impl() 6 | { 7 | struct Ini *ini = ini_parse_string(NULL, NULL); 8 | 9 | assert_true(ini == NULL); 10 | } 11 | 12 | 13 | int main() 14 | { 15 | test_run(test_impl); 16 | } 17 | 18 | -------------------------------------------------------------------------------- /tests/test_parse_string_invalid_section.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | 4 | 5 | void test_impl() 6 | { 7 | struct Ini *ini = ini_parse_string("[section\na=1", NULL); 8 | 9 | assert_true(ini == NULL); 10 | } 11 | 12 | 13 | int main() 14 | { 15 | test_run(test_impl); 16 | } 17 | 18 | -------------------------------------------------------------------------------- /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 | 11 | void assert_num_equal(size_t, size_t); 12 | void assert_string_equal(char *, char *); 13 | 14 | #endif 15 | 16 | -------------------------------------------------------------------------------- /tests/test_parse_string_empty_string.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | 4 | 5 | void test_impl() 6 | { 7 | struct Ini *ini = ini_parse_string("", NULL); 8 | 9 | assert_num_equal(ini->count, 0); 10 | 11 | ini_release_ini_structure(ini); 12 | } 13 | 14 | 15 | int main() 16 | { 17 | test_run(test_impl); 18 | } 19 | 20 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## CHANGELOG 2 | 3 | ### v0.1.1 4 | 5 | * Maintenance: Update string_buffer dependency 6 | * Added void to no arg functions 7 | * Added static to internal functions 8 | * Adding lint checks as part of build 9 | * Added cargo-make makefile for simpler sharing of optional development build instructions. 10 | * Updated header include guard macro name 11 | 12 | ### v0.1.0 (2020-12-28) 13 | 14 | * Initial release 15 | -------------------------------------------------------------------------------- /tests/test_new_specification.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | #include 4 | 5 | 6 | void test_impl() 7 | { 8 | struct IniSpecification *specification = ini_new_specification(); 9 | 10 | assert_true(specification->comment_character == ';'); 11 | assert_true(specification->allow_comment_after_value); 12 | 13 | free(specification); 14 | } 15 | 16 | 17 | int main() 18 | { 19 | test_run(test_impl); 20 | } 21 | 22 | -------------------------------------------------------------------------------- /.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_parse_string_simple.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | 4 | 5 | void test_impl() 6 | { 7 | struct Ini *ini = ini_parse_string("[section]\na=1", NULL); 8 | 9 | assert_num_equal(ini->count, 1); 10 | 11 | struct IniSection *section = ini->sections[0]; 12 | assert_string_equal(section->name, "section"); 13 | assert_num_equal(section->count, 1); 14 | assert_string_equal(section->key_value_pairs[0]->key, "a"); 15 | assert_string_equal(section->key_value_pairs[0]->value, "1"); 16 | 17 | ini_release_ini_structure(ini); 18 | } 19 | 20 | 21 | int main() 22 | { 23 | test_run(test_impl); 24 | } 25 | 26 | -------------------------------------------------------------------------------- /tests/test_parse_string_custom_specification.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | #include 4 | 5 | 6 | void test_impl() 7 | { 8 | struct IniSpecification *specification = ini_new_specification(); 9 | 10 | specification->comment_character = '#'; 11 | struct Ini *ini = ini_parse_string("[section]\na=1\n#b=2", specification); 12 | free(specification); 13 | 14 | assert_num_equal(ini->count, 1); 15 | 16 | struct IniSection *section = ini->sections[0]; 17 | assert_string_equal(section->name, "section"); 18 | assert_num_equal(section->count, 1); 19 | assert_string_equal(section->key_value_pairs[0]->key, "a"); 20 | assert_string_equal(section->key_value_pairs[0]->value, "1"); 21 | 22 | ini_release_ini_structure(ini); 23 | } 24 | 25 | 26 | int main() 27 | { 28 | test_run(test_impl); 29 | } 30 | 31 | -------------------------------------------------------------------------------- /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 | if (!value) 25 | { 26 | test_fail(); 27 | } 28 | } 29 | 30 | 31 | void assert_num_equal(size_t value1, size_t value2) 32 | { 33 | if (value1 != value2) 34 | { 35 | #ifdef linux 36 | printf("Assert Failed, value: %zu not equals to value: %zu", value1, value2); 37 | #endif 38 | test_fail(); 39 | } 40 | } 41 | 42 | 43 | void assert_string_equal(char *value1, char *value2) 44 | { 45 | if (strcmp(value1, value2) != 0) 46 | { 47 | printf("Assert Failed, value: %s not equals to value: %s", value1, value2); 48 | test_fail(); 49 | } 50 | } 51 | 52 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /examples/example.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include 3 | #include 4 | 5 | 6 | int main() 7 | { 8 | struct Ini *ini = ini_parse_string("; some comment\n\ 9 | key=value\n\ 10 | another_key=another value\n\ 11 | ; more comments\n\ 12 | \n\ 13 | [section1]\n\ 14 | a1=1\n\ 15 | a2=2\n\ 16 | [section2.subsection]\n\ 17 | c1=1", NULL); 18 | 19 | printf("Parse ini, total sections: %zu\n", ini->count); 20 | 21 | struct IniSection *section = ini->sections[0]; 22 | printf("Total key/values in first section: %zu\n", section->count); 23 | 24 | struct IniKeyValue *key_value_pair = section->key_value_pairs[0]; 25 | printf("First key: %s value: %s\n", key_value_pair->key, key_value_pair->value); 26 | key_value_pair = section->key_value_pairs[1]; 27 | printf("Second key: %s value: %s\n", key_value_pair->key, key_value_pair->value); 28 | 29 | char *ini_text = ini_to_string(ini); 30 | printf("Converted back to string:\n%s\n", ini_text); 31 | free(ini_text); 32 | 33 | ini_release_ini_structure(ini); 34 | 35 | return(0); 36 | } 37 | -------------------------------------------------------------------------------- /.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, windows-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 | -------------------------------------------------------------------------------- /include/ini.h: -------------------------------------------------------------------------------- 1 | #ifndef INI_H 2 | #define INI_H 3 | 4 | #include 5 | #include 6 | 7 | struct IniKeyValue 8 | { 9 | char *key; 10 | char *value; 11 | }; 12 | 13 | struct IniSection 14 | { 15 | char *name; 16 | struct IniKeyValue **key_value_pairs; 17 | size_t count; 18 | }; 19 | 20 | struct Ini 21 | { 22 | struct IniSection **sections; 23 | size_t count; 24 | }; 25 | 26 | struct IniSpecification 27 | { 28 | char comment_character; 29 | bool allow_comment_after_value; 30 | }; 31 | 32 | /** 33 | * Returns a new specification that can be altered. 34 | * It returns a default specification that is used by other functions 35 | * if no specification is provided to them. 36 | */ 37 | struct IniSpecification *ini_new_specification(void); 38 | 39 | /** 40 | * Parses the give string and returns the Ini structure. 41 | * In case of any error, this function will return null. 42 | * The specification parameter is optional and if not provided, the 43 | * default specification will be used. 44 | * The Ini structure must be fully released once done. 45 | */ 46 | struct Ini *ini_parse_string(char * /* ini_text */, struct IniSpecification *); 47 | 48 | /** 49 | * Writes the Ini struct as ini text and returns it. 50 | * This function will not validate the Ini structure is valid, for example 51 | * if multiple sections with same name exist. 52 | */ 53 | char *ini_to_string(struct Ini *); 54 | 55 | /** 56 | * Releases the Ini struct and all internal memory used. 57 | * All internal strings will also be released, therefore no const strings 58 | * or freed strings must reside in the structure. 59 | */ 60 | void ini_release_ini_structure(struct Ini *); 61 | 62 | #endif 63 | 64 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | pull_request: 6 | schedule: 7 | - cron: '0 23 * * 5' 8 | 9 | jobs: 10 | analyse: 11 | name: Analyse 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v2 17 | with: 18 | # We must fetch at least the immediate parents so that if this is 19 | # a pull request then we can checkout the head. 20 | fetch-depth: 2 21 | 22 | # If this run was triggered by a pull request event, then checkout 23 | # the head of the pull request instead of the merge commit. 24 | - run: git checkout HEAD^2 25 | if: ${{ github.event_name == 'pull_request' }} 26 | 27 | # Initializes the CodeQL tools for scanning. 28 | - name: Initialize CodeQL 29 | uses: github/codeql-action/init@v1 30 | with: 31 | languages: cpp 32 | # Override language selection by uncommenting this and choosing your languages 33 | # with: 34 | # languages: go, javascript, csharp, python, cpp, java 35 | 36 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 37 | # If this step fails, then you should remove it and run the build manually (see below) 38 | - name: Autobuild 39 | uses: github/codeql-action/autobuild@v1 40 | 41 | # ℹ️ Command-line programs to run using the OS shell. 42 | # 📚 https://git.io/JvXDl 43 | 44 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 45 | # and modify them (or add more) to build your code if your project 46 | # uses a compiled language 47 | 48 | #- run: | 49 | # make bootstrap 50 | # make release 51 | 52 | - name: Perform CodeQL Analysis 53 | uses: github/codeql-action/analyze@v1 54 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ini 2 | 3 | [![CI](https://github.com/sagiegurari/c_ini/workflows/CI/badge.svg?branch=master)](https://github.com/sagiegurari/c_ini/actions) 4 | [![Release](https://img.shields.io/github/v/release/sagiegurari/c_ini)](https://github.com/sagiegurari/c_ini/releases) 5 | [![license](https://img.shields.io/github/license/sagiegurari/c_ini)](https://github.com/sagiegurari/c_ini/blob/master/LICENSE) 6 | 7 | > INI parser/writer for C. 8 | 9 | * [Overview](#overview) 10 | * [Usage](#usage) 11 | * [Contributing](.github/CONTRIBUTING.md) 12 | * [Release History](CHANGELOG.md) 13 | * [License](#license) 14 | 15 | 16 | ## Overview 17 | This library provides both parsing INI text/files and creating INI text/files. 18 | 19 | 20 | ## Usage 21 | 22 | 23 | ```c 24 | #include "ini.h" 25 | #include 26 | #include 27 | 28 | 29 | int main() 30 | { 31 | struct Ini *ini = ini_parse_string("; some comment\n\ 32 | key=value\n\ 33 | another_key=another value\n\ 34 | ; more comments\n\ 35 | \n\ 36 | [section1]\n\ 37 | a1=1\n\ 38 | a2=2\n\ 39 | [section2.subsection]\n\ 40 | c1=1", NULL); 41 | 42 | printf("Parse ini, total sections: %zu\n", ini->count); 43 | 44 | struct IniSection *section = ini->sections[0]; 45 | printf("Total key/values in first section: %zu\n", section->count); 46 | 47 | struct IniKeyValue *key_value_pair = section->key_value_pairs[0]; 48 | printf("First key: %s value: %s\n", key_value_pair->key, key_value_pair->value); 49 | key_value_pair = section->key_value_pairs[1]; 50 | printf("Second key: %s value: %s\n", key_value_pair->key, key_value_pair->value); 51 | 52 | char *ini_text = ini_to_string(ini); 53 | printf("Converted back to string:\n%s\n", ini_text); 54 | free(ini_text); 55 | 56 | ini_release_ini_structure(ini); 57 | 58 | return(0); 59 | } 60 | ``` 61 | 62 | 63 | ## Contributing 64 | See [contributing guide](.github/CONTRIBUTING.md) 65 | 66 | 67 | ## Release History 68 | 69 | See [Changelog](CHANGELOG.md) 70 | 71 | 72 | ## License 73 | Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license. 74 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | 2 | cmake_minimum_required(VERSION 3.7) 3 | 4 | project(ini 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 | if(NOT WIN32) 16 | set(X_CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror -Wall -Wextra -Wcast-align -Wunused -Wshadow -Wpedantic") 17 | endif() 18 | 19 | set(X_CMAKE_PROJECT_ROOT_DIR ${CMAKE_BINARY_DIR}/..) 20 | 21 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 22 | set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 23 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 24 | 25 | macro(add_external_lib) 26 | utils_add_external_github_lib( 27 | REPO_USERNAME sagiegurari 28 | REPO_NAME c_${ARGV0} 29 | TAG_NAME ${ARGV1} 30 | LIBRARY_NAME ${ARGV0} 31 | LIBRARY_PARENT_DIRECTORY target 32 | ) 33 | endmacro(add_external_lib) 34 | add_external_lib("stringfn") 35 | add_external_lib("string_buffer") 36 | add_external_lib("vector") 37 | 38 | include_directories(include "${STRINGFN_INCLUDE}" "${STRING_BUFFER_INCLUDE}" "${VECTOR_INCLUDE}") 39 | 40 | # define all sources 41 | file(GLOB SOURCES "src/*.c") 42 | file(GLOB HEADER_SOURCES "include/*.h") 43 | file(GLOB TEST_SOURCES "tests/*") 44 | file(GLOB COMMON_TEST_SOURCES "tests/test.*") 45 | file(GLOB EXAMPLE_SOURCES "examples/*.c") 46 | 47 | # lint code 48 | utils_cppcheck(INCLUDE_DIRECTORY "./include/" SOURCES "./src/*.c" WORKING_DIRECTORY "${X_CMAKE_PROJECT_ROOT_DIR}") 49 | 50 | # format code 51 | utils_uncrustify( 52 | CONFIG_FILE "${X_CMAKE_PROJECT_ROOT_DIR}/uncrustify.cfg" 53 | SOURCES ${SOURCES} ${HEADER_SOURCES} ${TEST_SOURCES} ${EXAMPLE_SOURCES} 54 | ) 55 | 56 | # create static library 57 | add_library(${CMAKE_PROJECT_NAME} STATIC ${SOURCES} ${STRINGFN_SOURCES} ${STRING_BUFFER_SOURCES} ${VECTOR_SOURCES}) 58 | if(NOT WIN32) 59 | set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS} -Wconversion") 60 | endif() 61 | 62 | # example 63 | add_executable(example examples/example.c) 64 | target_link_libraries(example ${CMAKE_PROJECT_NAME}) 65 | set_target_properties(example PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS}") 66 | 67 | # tests 68 | include(CTest) 69 | 70 | utils_setup_test_lib( 71 | SOURCES "${COMMON_TEST_SOURCES}" 72 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 73 | ) 74 | utils_setup_c_all_tests( 75 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 76 | BINARY_DIRECTORY "${CMAKE_BINARY_DIR}/bin" 77 | LIBRARIES "Test" 78 | ) 79 | 80 | if("$ENV{X_CMAKE_DOC_STEPS}" STREQUAL "true") 81 | # post build steps 82 | add_custom_command( 83 | TARGET example 84 | POST_BUILD 85 | COMMENT "Post Build Steps" 86 | COMMAND ${CMAKE_COMMAND} -P "../post-example-build.cmake" 87 | ) 88 | endif() 89 | 90 | -------------------------------------------------------------------------------- /tests/test_parse_string_complex.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "test.h" 3 | #include 4 | 5 | 6 | void test_impl() 7 | { 8 | struct Ini *ini = ini_parse_string(";test\n\ 9 | \ 10 | topk1=topv1\n\ 11 | topk2=topv2\n\ 12 | ; comment\n\ 13 | \n\ 14 | topk3=topv3;comment\n\ 15 | \n\ 16 | [section1]\n\ 17 | a1\\n2=1\n\ 18 | a2\\=3=2\n\ 19 | [section2]\n\ 20 | b1=1\\n2\\n3\n\ 21 | \n\ 22 | \n\ 23 | b2=2\n\ 24 | [section3]\n\ 25 | [section4.subsection]\n\ 26 | c1=1=2", NULL); 27 | 28 | assert_num_equal(ini->count, 5); 29 | 30 | struct IniSection *section = ini->sections[0]; 31 | assert_string_equal(section->name, ""); 32 | assert_num_equal(section->count, 3); 33 | assert_string_equal(section->key_value_pairs[0]->key, "topk1"); 34 | assert_string_equal(section->key_value_pairs[0]->value, "topv1"); 35 | assert_string_equal(section->key_value_pairs[1]->key, "topk2"); 36 | assert_string_equal(section->key_value_pairs[1]->value, "topv2"); 37 | assert_string_equal(section->key_value_pairs[2]->key, "topk3"); 38 | assert_string_equal(section->key_value_pairs[2]->value, "topv3"); 39 | 40 | section = ini->sections[1]; 41 | assert_string_equal(section->name, "section1"); 42 | assert_num_equal(section->count, 2); 43 | assert_string_equal(section->key_value_pairs[0]->key, "a1\n2"); 44 | assert_string_equal(section->key_value_pairs[0]->value, "1"); 45 | assert_string_equal(section->key_value_pairs[1]->key, "a2=3"); 46 | assert_string_equal(section->key_value_pairs[1]->value, "2"); 47 | 48 | section = ini->sections[2]; 49 | assert_string_equal(section->name, "section2"); 50 | assert_num_equal(section->count, 2); 51 | assert_string_equal(section->key_value_pairs[0]->key, "b1"); 52 | assert_string_equal(section->key_value_pairs[0]->value, "1\n2\n3"); 53 | assert_string_equal(section->key_value_pairs[1]->key, "b2"); 54 | assert_string_equal(section->key_value_pairs[1]->value, "2"); 55 | 56 | section = ini->sections[3]; 57 | assert_string_equal(section->name, "section3"); 58 | assert_num_equal(section->count, 0); 59 | 60 | section = ini->sections[4]; 61 | assert_string_equal(section->name, "section4.subsection"); 62 | assert_num_equal(section->count, 1); 63 | assert_string_equal(section->key_value_pairs[0]->key, "c1"); 64 | assert_string_equal(section->key_value_pairs[0]->value, "1=2"); 65 | 66 | char *ini_text = ini_to_string(ini); 67 | char *normalized = "topk1=topv1\n\ 68 | topk2=topv2\n\ 69 | topk3=topv3\n\ 70 | \n\ 71 | [section1]\n\ 72 | a1\\n2=1\n\ 73 | a2\\=3=2\n\ 74 | \n\ 75 | [section2]\n\ 76 | b1=1\\n2\\n3\n\ 77 | b2=2\n\ 78 | \n\ 79 | [section3]\n\ 80 | \n\ 81 | [section4.subsection]\n\ 82 | c1=1=2\n\ 83 | \n"; 84 | assert_string_equal(ini_text, normalized); 85 | free(ini_text); 86 | ini_release_ini_structure(ini); 87 | } /* test_impl */ 88 | 89 | 90 | int main() 91 | { 92 | test_run(test_impl); 93 | } 94 | 95 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /src/ini.c: -------------------------------------------------------------------------------- 1 | #include "ini.h" 2 | #include "stringbuffer.h" 3 | #include "stringfn.h" 4 | #include "vector.h" 5 | #include 6 | #include 7 | 8 | static struct IniKeyValue *_ini_split_key_value(struct StringBuffer *, char *); 9 | static char *_ini_parse_value(struct StringBuffer *, char *, struct IniSpecification *); 10 | static bool _ini_section_to_string(struct StringBuffer *, struct IniSection *); 11 | static void _ini_release_ini_section(struct IniSection *); 12 | 13 | struct IniSpecification *ini_new_specification(void) 14 | { 15 | struct IniSpecification *specification = malloc(sizeof(struct IniSpecification)); 16 | 17 | specification->comment_character = ';'; 18 | specification->allow_comment_after_value = true; 19 | 20 | return(specification); 21 | } 22 | 23 | struct Ini *ini_parse_string(char *ini_text, struct IniSpecification *specification) 24 | { 25 | if (ini_text == NULL) 26 | { 27 | return(NULL); 28 | } 29 | 30 | bool release_specification = false; 31 | if (specification == NULL) 32 | { 33 | specification = ini_new_specification(); 34 | release_specification = true; 35 | } 36 | 37 | struct StringBuffer *buffer = stringbuffer_new(); 38 | struct Vector *sections = vector_new(); 39 | struct Vector *key_value_pairs = vector_new(); 40 | struct StringFNStrings lines = stringfn_split_lines_and_trim(ini_text); 41 | bool valid = true; 42 | char *section_name = NULL; 43 | for (int index = 0; index < lines.count; index++) 44 | { 45 | char *line = lines.strings[index]; 46 | size_t line_length = strlen(line); 47 | 48 | if (!line_length || line[0] == specification->comment_character) 49 | { 50 | continue; 51 | } 52 | 53 | if (line[0] == '[') 54 | { 55 | if (line[line_length - 1] == ']') 56 | { 57 | if (section_name != NULL || vector_size(key_value_pairs)) 58 | { 59 | struct IniSection *section = malloc(sizeof(struct IniSection)); 60 | section->name = section_name; 61 | if (section->name == NULL) 62 | { 63 | section->name = strdup(""); 64 | } 65 | section->count = vector_size(key_value_pairs); 66 | section->key_value_pairs = (struct IniKeyValue **)vector_to_array(key_value_pairs); 67 | vector_clear(key_value_pairs); 68 | vector_push(sections, section); 69 | } 70 | 71 | section_name = stringfn_substring(line, 1, line_length - 2); 72 | } 73 | else 74 | { 75 | valid = false; 76 | break; 77 | } 78 | } 79 | else 80 | { 81 | struct IniKeyValue *key_value_pair = _ini_split_key_value(buffer, line); 82 | if (key_value_pair != NULL) 83 | { 84 | char *key = stringfn_trim(key_value_pair->key); 85 | char *value = stringfn_trim(key_value_pair->value); 86 | free(key_value_pair->key); 87 | if (key_value_pair->value != NULL) 88 | { 89 | free(key_value_pair->value); 90 | } 91 | 92 | key = _ini_parse_value(buffer, key, specification); 93 | value = _ini_parse_value(buffer, value, specification); 94 | 95 | key_value_pair->key = key; 96 | key_value_pair->value = value; 97 | vector_push(key_value_pairs, key_value_pair); 98 | } 99 | else 100 | { 101 | valid = false; 102 | break; 103 | } 104 | } 105 | } 106 | 107 | stringfn_release_strings_struct(lines); 108 | 109 | if (section_name != NULL || vector_size(key_value_pairs)) 110 | { 111 | struct IniSection *section = malloc(sizeof(struct IniSection)); 112 | section->name = section_name; 113 | if (section->name == NULL) 114 | { 115 | section->name = strdup(""); 116 | } 117 | section->count = vector_size(key_value_pairs); 118 | section->key_value_pairs = (struct IniKeyValue **)vector_to_array(key_value_pairs); 119 | vector_clear(key_value_pairs); 120 | vector_push(sections, section); 121 | } 122 | 123 | struct Ini *ini = malloc(sizeof(struct Ini)); 124 | ini->count = vector_size(sections); 125 | ini->sections = (struct IniSection **)vector_to_array(sections); 126 | 127 | stringbuffer_release(buffer); 128 | vector_release(key_value_pairs); 129 | vector_release(sections); 130 | 131 | if (release_specification) 132 | { 133 | free(specification); 134 | } 135 | 136 | if (!valid) 137 | { 138 | ini_release_ini_structure(ini); 139 | return(NULL); 140 | } 141 | 142 | return(ini); 143 | } /* ini_parse_string */ 144 | 145 | 146 | char *ini_to_string(struct Ini *ini) 147 | { 148 | if (ini == NULL) 149 | { 150 | return(NULL); 151 | } 152 | 153 | if (ini->sections == NULL || !ini->count) 154 | { 155 | return(strdup("")); 156 | } 157 | 158 | struct StringBuffer *buffer = stringbuffer_new(); 159 | 160 | for (size_t index = 0; index < ini->count; index++) 161 | { 162 | if (!_ini_section_to_string(buffer, ini->sections[index])) 163 | { 164 | stringbuffer_release(buffer); 165 | return(NULL); 166 | } 167 | } 168 | 169 | char *ini_text = stringbuffer_to_string(buffer); 170 | stringbuffer_release(buffer); 171 | 172 | return(ini_text); 173 | } 174 | 175 | 176 | void ini_release_ini_structure(struct Ini *ini) 177 | { 178 | if (ini == NULL) 179 | { 180 | return; 181 | } 182 | 183 | if (ini->sections != NULL) 184 | { 185 | for (size_t index = 0; index < ini->count; index++) 186 | { 187 | _ini_release_ini_section(ini->sections[index]); 188 | } 189 | 190 | free(ini->sections); 191 | } 192 | 193 | free(ini); 194 | } 195 | 196 | static struct IniKeyValue *_ini_split_key_value(struct StringBuffer *buffer, char *line) 197 | { 198 | stringbuffer_clear(buffer); 199 | 200 | size_t length = strlen(line); 201 | if (!length) 202 | { 203 | return(NULL); 204 | } 205 | 206 | bool in_escape = false; 207 | char *key = NULL; 208 | char *value = NULL; 209 | for (size_t index = 0; index < length; index++) 210 | { 211 | char character = line[index]; 212 | 213 | if (in_escape) 214 | { 215 | if (character == '=') 216 | { 217 | stringbuffer_append(buffer, '='); 218 | } 219 | else 220 | { 221 | stringbuffer_append(buffer, '\\'); 222 | stringbuffer_append(buffer, character); 223 | } 224 | 225 | in_escape = false; 226 | } 227 | else if (character == '\\') 228 | { 229 | in_escape = true; 230 | } 231 | else if (character == '=') 232 | { 233 | key = stringbuffer_to_string(buffer); 234 | value = stringfn_substring(line, (int)(index + 1), 0); 235 | break; 236 | } 237 | else 238 | { 239 | stringbuffer_append(buffer, character); 240 | } 241 | } 242 | 243 | if (key == NULL) 244 | { 245 | return(NULL); 246 | } 247 | 248 | struct IniKeyValue *key_value_pair = malloc(sizeof(struct IniKeyValue)); 249 | key_value_pair->key = key; 250 | key_value_pair->value = value; 251 | 252 | return(key_value_pair); 253 | } /* _ini_split_key_value */ 254 | 255 | 256 | static char *_ini_parse_value(struct StringBuffer *buffer, char *value, struct IniSpecification *specification) 257 | { 258 | size_t value_length = strlen(value); 259 | 260 | if (!value_length) 261 | { 262 | return(value); 263 | } 264 | 265 | stringbuffer_clear(buffer); 266 | 267 | bool in_escape = false; 268 | for (size_t index = 0; index < value_length; index++) 269 | { 270 | char character = value[index]; 271 | 272 | if (in_escape) 273 | { 274 | if (character == 'n') 275 | { 276 | stringbuffer_append(buffer, '\n'); 277 | } 278 | else if (character == specification->comment_character) 279 | { 280 | stringbuffer_append(buffer, specification->comment_character); 281 | } 282 | else 283 | { 284 | stringbuffer_append(buffer, '\\'); 285 | stringbuffer_append(buffer, character); 286 | } 287 | 288 | in_escape = false; 289 | } 290 | else if (character == '\\') 291 | { 292 | in_escape = true; 293 | } 294 | else if (character == specification->comment_character && specification->allow_comment_after_value) 295 | { 296 | break; 297 | } 298 | else 299 | { 300 | stringbuffer_append(buffer, character); 301 | } 302 | } 303 | 304 | if (in_escape) 305 | { 306 | stringbuffer_append(buffer, '\\'); 307 | } 308 | 309 | free(value); 310 | value = stringbuffer_to_string(buffer); 311 | 312 | return(value); 313 | } /* _ini_parse_value */ 314 | 315 | 316 | static void _ini_value_to_string(struct StringBuffer *buffer, char *value, bool is_key) 317 | { 318 | if (value == NULL) 319 | { 320 | return; 321 | } 322 | 323 | size_t length = strlen(value); 324 | 325 | for (size_t index = 0; index < length; index++) 326 | { 327 | if (value[index] == '\n') 328 | { 329 | stringbuffer_append_string(buffer, "\\n"); 330 | } 331 | else if (is_key && value[index] == '=') 332 | { 333 | stringbuffer_append_string(buffer, "\\="); 334 | } 335 | else 336 | { 337 | stringbuffer_append(buffer, value[index]); 338 | } 339 | } 340 | } 341 | 342 | 343 | static bool _ini_key_value_to_string(struct StringBuffer *buffer, struct IniKeyValue *key_value) 344 | { 345 | if (key_value == NULL) 346 | { 347 | return(true); 348 | } 349 | 350 | if (key_value->key == NULL || !strlen(key_value->key)) 351 | { 352 | return(false); 353 | } 354 | 355 | _ini_value_to_string(buffer, key_value->key, true); 356 | stringbuffer_append(buffer, '='); 357 | _ini_value_to_string(buffer, key_value->value, false); 358 | stringbuffer_append(buffer, '\n'); 359 | 360 | return(true); 361 | } 362 | 363 | 364 | static bool _ini_section_to_string(struct StringBuffer *buffer, struct IniSection *section) 365 | { 366 | if (section == NULL) 367 | { 368 | return(true); 369 | } 370 | 371 | if (section->name != NULL && strlen(section->name)) 372 | { 373 | stringbuffer_append(buffer, '['); 374 | stringbuffer_append_string(buffer, section->name); 375 | stringbuffer_append_string(buffer, "]\n"); 376 | } 377 | 378 | if (section->key_value_pairs != NULL) 379 | { 380 | for (size_t index = 0; index < section->count; index++) 381 | { 382 | if (!_ini_key_value_to_string(buffer, section->key_value_pairs[index])) 383 | { 384 | return(false); 385 | } 386 | } 387 | } 388 | 389 | stringbuffer_append(buffer, '\n'); 390 | 391 | return(true); 392 | } 393 | 394 | 395 | static void _ini_release_ini_key_value(struct IniKeyValue *key_value) 396 | { 397 | if (key_value == NULL) 398 | { 399 | return; 400 | } 401 | 402 | if (key_value->key != NULL) 403 | { 404 | free(key_value->key); 405 | } 406 | if (key_value->value != NULL) 407 | { 408 | free(key_value->value); 409 | } 410 | 411 | free(key_value); 412 | } 413 | 414 | 415 | static void _ini_release_ini_section(struct IniSection *section) 416 | { 417 | if (section == NULL) 418 | { 419 | return; 420 | } 421 | 422 | if (section->name != NULL) 423 | { 424 | free(section->name); 425 | } 426 | 427 | if (section->key_value_pairs != NULL) 428 | { 429 | for (size_t index = 0; index < section->count; index++) 430 | { 431 | _ini_release_ini_key_value(section->key_value_pairs[index]); 432 | } 433 | 434 | free(section->key_value_pairs); 435 | } 436 | 437 | free(section); 438 | } 439 | 440 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------