├── tests ├── basic │ ├── .gitignore │ ├── assets │ │ ├── resource1.txt │ │ └── resource2.txt │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── extended │ ├── .gitignore │ ├── assets │ │ ├── resource1.txt │ │ ├── resource2.txt │ │ ├── resource4.jpg │ │ ├── resource5.jpg │ │ └── resource3.xml │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── compress-all │ ├── .gitignore │ ├── assets │ │ ├── resource1.txt │ │ └── resource2.txt │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── create-c-code │ ├── .gitignore │ ├── assets │ │ ├── resource1.txt │ │ └── resource2.txt │ ├── snapshots │ │ ├── resources.gresource.xml │ │ └── resources.c │ └── CMakeLists.txt ├── custom-target │ ├── .gitignore │ ├── assets │ │ └── resource.txt │ ├── snapshots │ │ ├── custom-resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── topixdata-all │ ├── .gitignore │ ├── assets │ │ ├── resource1.jpg │ │ └── resource2.jpg │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── source-dir-absolute │ ├── .gitignore │ ├── assets │ │ └── resource.txt │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── source-dir-relative │ ├── .gitignore │ ├── assets │ │ └── resource.txt │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ └── CMakeLists.txt ├── stripblanks-all │ ├── .gitignore │ ├── snapshots │ │ ├── resources.gresource │ │ └── resources.gresource.xml │ ├── assets │ │ ├── resource2.xml │ │ └── resource1.xml │ └── CMakeLists.txt └── test.bats ├── macros ├── GlibCompileResourcesSupport.cmake ├── BuildTargetScript.cmake ├── GenerateGXML.cmake └── CompileGResources.cmake ├── .github └── workflows │ └── test.yml ├── README.md └── LICENSE /tests/basic/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/extended/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/compress-all/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/create-c-code/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/custom-target/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/topixdata-all/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/source-dir-absolute/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/source-dir-relative/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/stripblanks-all/.gitignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | -------------------------------------------------------------------------------- /tests/basic/assets/resource1.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/basic/assets/resource2.txt: -------------------------------------------------------------------------------- 1 | this is test resource #2 2 | -------------------------------------------------------------------------------- /tests/extended/assets/resource1.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/compress-all/assets/resource1.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/compress-all/assets/resource2.txt: -------------------------------------------------------------------------------- 1 | this is test resource #2 2 | -------------------------------------------------------------------------------- /tests/create-c-code/assets/resource1.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/custom-target/assets/resource.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/extended/assets/resource2.txt: -------------------------------------------------------------------------------- 1 | this is test resource #2 2 | -------------------------------------------------------------------------------- /tests/create-c-code/assets/resource2.txt: -------------------------------------------------------------------------------- 1 | this is test resource #2 2 | -------------------------------------------------------------------------------- /tests/source-dir-absolute/assets/resource.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/source-dir-relative/assets/resource.txt: -------------------------------------------------------------------------------- 1 | this is a test resource 2 | -------------------------------------------------------------------------------- /tests/extended/assets/resource4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/extended/assets/resource4.jpg -------------------------------------------------------------------------------- /tests/extended/assets/resource5.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/extended/assets/resource5.jpg -------------------------------------------------------------------------------- /tests/topixdata-all/assets/resource1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/topixdata-all/assets/resource1.jpg -------------------------------------------------------------------------------- /tests/topixdata-all/assets/resource2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/topixdata-all/assets/resource2.jpg -------------------------------------------------------------------------------- /tests/basic/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/basic/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/extended/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/extended/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/compress-all/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/compress-all/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/topixdata-all/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/topixdata-all/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/stripblanks-all/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/stripblanks-all/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/source-dir-absolute/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/source-dir-absolute/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/source-dir-relative/snapshots/resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/source-dir-relative/snapshots/resources.gresource -------------------------------------------------------------------------------- /tests/custom-target/snapshots/custom-resources.gresource: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Makman2/GCR_CMake/HEAD/tests/custom-target/snapshots/custom-resources.gresource -------------------------------------------------------------------------------- /tests/custom-target/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource.txt -------------------------------------------------------------------------------- /tests/source-dir-absolute/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | resource.txt -------------------------------------------------------------------------------- /tests/source-dir-relative/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | resource.txt -------------------------------------------------------------------------------- /tests/basic/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource1.txtassets/resource2.txt -------------------------------------------------------------------------------- /tests/create-c-code/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource1.txtassets/resource2.txt -------------------------------------------------------------------------------- /tests/compress-all/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource1.txtassets/resource2.txt -------------------------------------------------------------------------------- /tests/topixdata-all/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource1.jpgassets/resource2.jpg -------------------------------------------------------------------------------- /tests/stripblanks-all/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource1.xmlassets/resource2.xml -------------------------------------------------------------------------------- /tests/extended/assets/resource3.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tove 4 |
Teststreet 12
5 | 6 | 7 | Jani 8 |
Main Ave. 102
9 | 10 | Reminder 11 | Don't forget me this weekend! 12 | 13 | -------------------------------------------------------------------------------- /tests/stripblanks-all/assets/resource2.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Adam 4 |
Teststreet 13
5 | 6 | 7 | Eva 8 |
Main Ave. 104
9 | 10 | Note 11 | Don't forget me this week! 12 | 13 | -------------------------------------------------------------------------------- /tests/stripblanks-all/assets/resource1.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tove 4 |
Teststreet 12
5 | 6 | 7 | Jani 8 |
Main Ave. 102
9 | 10 | Reminder 11 | Don't forget me this weekend! 12 | 13 | -------------------------------------------------------------------------------- /tests/extended/snapshots/resources.gresource.xml: -------------------------------------------------------------------------------- 1 | assets/resource1.txtassets/resource2.txtassets/resource3.xmlassets/resource4.jpgassets/resource5.jpg -------------------------------------------------------------------------------- /macros/GlibCompileResourcesSupport.cmake: -------------------------------------------------------------------------------- 1 | # Path to this file. 2 | set(GCR_CMAKE_MACRO_DIR ${CMAKE_CURRENT_LIST_DIR}) 3 | 4 | # Finds the glib-compile-resources executable. 5 | find_program(GLIB_COMPILE_RESOURCES_EXECUTABLE glib-compile-resources) 6 | mark_as_advanced(GLIB_COMPILE_RESOURCES_EXECUTABLE) 7 | 8 | # Include the cmake files containing the functions. 9 | include(${GCR_CMAKE_MACRO_DIR}/CompileGResources.cmake) 10 | include(${GCR_CMAKE_MACRO_DIR}/GenerateGXML.cmake) 11 | 12 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | on: 3 | push: 4 | branches: 5 | - master 6 | pull_request: 7 | jobs: 8 | test: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v2 12 | - uses: actions/setup-node@v2 13 | with: 14 | node-version: '14' 15 | - run: npm install -g bats 16 | - run: sudo apt-get install -y cmake libxml2-utils 17 | - name: Run Tests 18 | working-directory: tests 19 | run: ./test.bats 20 | -------------------------------------------------------------------------------- /tests/basic/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES assets/resource1.txt assets/resource2.txt) 12 | 13 | compile_gresources(RESOURCE_OUT 14 | XML_OUT 15 | TYPE BUNDLE 16 | RESOURCES ${RESOURCES}) 17 | 18 | add_custom_target(resources 19 | ALL 20 | DEPENDS ${RESOURCE_OUT}) 21 | -------------------------------------------------------------------------------- /tests/create-c-code/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES assets/resource1.txt assets/resource2.txt) 12 | 13 | compile_gresources(RESOURCE_OUT 14 | XML_OUT 15 | TYPE EMBED_C 16 | RESOURCES ${RESOURCES}) 17 | 18 | add_custom_target(resources 19 | ALL 20 | DEPENDS ${RESOURCE_OUT}) 21 | -------------------------------------------------------------------------------- /tests/compress-all/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES assets/resource1.txt assets/resource2.txt) 12 | 13 | compile_gresources(RESOURCE_OUT 14 | XML_OUT 15 | TYPE BUNDLE 16 | RESOURCES ${RESOURCES} 17 | COMPRESS_ALL) 18 | 19 | add_custom_target(resources 20 | ALL 21 | DEPENDS ${RESOURCE_OUT}) 22 | -------------------------------------------------------------------------------- /tests/topixdata-all/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES assets/resource1.jpg assets/resource2.jpg) 12 | 13 | compile_gresources(RESOURCE_OUT 14 | XML_OUT 15 | TYPE BUNDLE 16 | RESOURCES ${RESOURCES} 17 | TOPIXDATA_ALL) 18 | 19 | add_custom_target(resources 20 | ALL 21 | DEPENDS ${RESOURCE_OUT}) 22 | -------------------------------------------------------------------------------- /tests/stripblanks-all/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES assets/resource1.xml assets/resource2.xml) 12 | 13 | compile_gresources(RESOURCE_OUT 14 | XML_OUT 15 | TYPE BUNDLE 16 | RESOURCES ${RESOURCES} 17 | STRIPBLANKS_ALL) 18 | 19 | add_custom_target(resources 20 | ALL 21 | DEPENDS ${RESOURCE_OUT}) 22 | -------------------------------------------------------------------------------- /tests/custom-target/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES assets/resource.txt) 12 | 13 | compile_gresources(RESOURCE_OUT 14 | XML_OUT 15 | TYPE BUNDLE 16 | TARGET ${CMAKE_BINARY_DIR}/custom-resources.gresource 17 | RESOURCES ${RESOURCES}) 18 | 19 | add_custom_target(resources 20 | ALL 21 | DEPENDS ${RESOURCE_OUT}) 22 | -------------------------------------------------------------------------------- /tests/source-dir-relative/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | # We use SOURCE_DIR below relative to "assets", so the asset paths should work relative to this directory. 12 | list(APPEND RESOURCES resource.txt) 13 | 14 | compile_gresources(RESOURCE_OUT 15 | XML_OUT 16 | TYPE BUNDLE 17 | SOURCE_DIR assets 18 | RESOURCES ${RESOURCES}) 19 | 20 | add_custom_target(resources 21 | ALL 22 | DEPENDS ${RESOURCE_OUT}) 23 | -------------------------------------------------------------------------------- /tests/extended/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | list(APPEND RESOURCES 12 | COMPRESS assets/resource1.txt 13 | assets/resource2.txt 14 | STRIPBLANKS assets/resource3.xml 15 | TOPIXDATA assets/resource4.jpg 16 | assets/resource5.jpg) 17 | 18 | compile_gresources(RESOURCE_OUT 19 | XML_OUT 20 | TYPE BUNDLE 21 | RESOURCES ${RESOURCES}) 22 | 23 | add_custom_target(resources 24 | ALL 25 | DEPENDS ${RESOURCE_OUT}) 26 | -------------------------------------------------------------------------------- /tests/source-dir-absolute/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.0) 2 | 3 | get_filename_component(ProjectFolder ${CMAKE_CURRENT_LIST_DIR} NAME) 4 | string(REPLACE " " "_" ProjectFolder ${ProjectFolder}) 5 | project("GCR_CMake-testcase-${ProjectFolder}") 6 | 7 | list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../macros) 8 | 9 | include(GlibCompileResourcesSupport) 10 | 11 | # We use SOURCE_DIR below relative to "assets", so the asset paths should work relative to this directory. 12 | list(APPEND RESOURCES resource.txt) 13 | 14 | compile_gresources(RESOURCE_OUT 15 | XML_OUT 16 | TYPE BUNDLE 17 | SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/assets 18 | RESOURCES ${RESOURCES}) 19 | 20 | add_custom_target(resources 21 | ALL 22 | DEPENDS ${RESOURCE_OUT}) 23 | -------------------------------------------------------------------------------- /macros/BuildTargetScript.cmake: -------------------------------------------------------------------------------- 1 | # This file is used to be invoked at build time. It generates the needed 2 | # resource XML file. 3 | 4 | # Input variables that need to provided when invoking this script: 5 | # GXML_OUTPUT The output file path where to save the XML file. 6 | # GXML_COMPRESS_ALL Sets all COMPRESS flags in all resources in resource 7 | # list. 8 | # GXML_NO_COMPRESS_ALL Removes all COMPRESS flags in all resources in 9 | # resource list. 10 | # GXML_STRIPBLANKS_ALL Sets all STRIPBLANKS flags in all resources in 11 | # resource list. 12 | # GXML_NO_STRIPBLANKS_ALL Removes all STRIPBLANKS flags in all resources in 13 | # resource list. 14 | # GXML_TOPIXDATA_ALL Sets all TOPIXDATA flags i nall resources in resource 15 | # list. 16 | # GXML_NO_TOPIXDATA_ALL Removes all TOPIXDATA flags in all resources in 17 | # resource list. 18 | # GXML_PREFIX Overrides the resource prefix that is prepended to 19 | # each relative name in registered resources. 20 | # GXML_RESOURCES The list of resource files. Whether absolute or 21 | # relative path is equal. 22 | 23 | # Include the GENERATE_GXML() function. 24 | include(${CMAKE_CURRENT_LIST_DIR}/GenerateGXML.cmake) 25 | 26 | # Set flags to actual invocation flags. 27 | if(GXML_COMPRESS_ALL) 28 | set(GXML_COMPRESS_ALL COMPRESS_ALL) 29 | endif() 30 | if(GXML_NO_COMPRESS_ALL) 31 | set(GXML_NO_COMPRESS_ALL NO_COMPRESS_ALL) 32 | endif() 33 | if(GXML_STRIPBLANKS_ALL) 34 | set(GXML_STRIPBLANKS_ALL STRIPBLANKS_ALL) 35 | endif() 36 | if(GXML_NO_STRIPBLANKS_ALL) 37 | set(GXML_NO_STRIPBLANKS_ALL NO_STRIPBLANKS_ALL) 38 | endif() 39 | if(GXML_TOPIXDATA_ALL) 40 | set(GXML_TOPIXDATA_ALL TOPIXDATA_ALL) 41 | endif() 42 | if(GXML_NO_TOPIXDATA_ALL) 43 | set(GXML_NO_TOPIXDATA_ALL NO_TOPIXDATA_ALL) 44 | endif() 45 | 46 | # Replace " " with ";" to import the list over the command line. Otherwise 47 | # CMake would interprete the passed resources as a whole string. 48 | string(REPLACE " " ";" GXML_RESOURCES ${GXML_RESOURCES}) 49 | 50 | # Invoke the gresource XML generation function. 51 | generate_gxml(${GXML_OUTPUT} 52 | ${GXML_COMPRESS_ALL} ${GXML_NO_COMPRESS_ALL} 53 | ${GXML_STRIPBLANKS_ALL} ${GXML_NO_STRIPBLANKS_ALL} 54 | ${GXML_TOPIXDATA_ALL} ${GXML_NO_TOPIXDATA_ALL} 55 | PREFIX ${GXML_PREFIX} 56 | RESOURCES ${GXML_RESOURCES}) 57 | 58 | -------------------------------------------------------------------------------- /tests/test.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | @test "basic test" { 4 | cd basic 5 | 6 | rm -rf build 7 | mkdir build 8 | cd build 9 | cmake .. 10 | make 11 | cd .. 12 | 13 | [ -f "build/resources.gresource.xml" ] 14 | [ -f "build/resources.gresource" ] 15 | 16 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 17 | diff "build/resources.gresource" "snapshots/resources.gresource" 18 | } 19 | 20 | @test "COMPRESS_ALL works" { 21 | cd compress-all 22 | 23 | rm -rf build 24 | mkdir build 25 | cd build 26 | cmake .. 27 | make 28 | cd .. 29 | 30 | [ -f "build/resources.gresource.xml" ] 31 | [ -f "build/resources.gresource" ] 32 | 33 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 34 | diff "build/resources.gresource" "snapshots/resources.gresource" 35 | } 36 | 37 | @test "EMBED_C type-option works" { 38 | cd create-c-code 39 | 40 | rm -rf build 41 | mkdir build 42 | cd build 43 | cmake .. 44 | make 45 | cd .. 46 | 47 | [ -f "build/resources.gresource.xml" ] 48 | [ -f "build/resources.c" ] 49 | 50 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 51 | diff "build/resources.c" "snapshots/resources.c" 52 | } 53 | 54 | @test "setting TARGET to a custom value works" { 55 | cd custom-target 56 | 57 | rm -rf build 58 | mkdir build 59 | cd build 60 | cmake .. 61 | make 62 | cd .. 63 | 64 | [ -f "build/resources.gresource.xml" ] 65 | [ -f "build/custom-resources.gresource" ] 66 | 67 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 68 | diff "build/custom-resources.gresource" "snapshots/custom-resources.gresource" 69 | } 70 | 71 | @test "extended test" { 72 | cd extended 73 | 74 | rm -rf build 75 | mkdir build 76 | cd build 77 | cmake .. 78 | make 79 | cd .. 80 | 81 | [ -f "build/resources.gresource.xml" ] 82 | [ -f "build/resources.gresource" ] 83 | 84 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 85 | diff "build/resources.gresource" "snapshots/resources.gresource" 86 | } 87 | 88 | @test "SOURCE_DIR argument works properly with relative paths" { 89 | cd source-dir-relative 90 | 91 | rm -rf build 92 | mkdir build 93 | cd build 94 | cmake .. 95 | make 96 | cd .. 97 | 98 | [ -f "build/resources.gresource.xml" ] 99 | [ -f "build/resources.gresource" ] 100 | 101 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 102 | diff "build/resources.gresource" "snapshots/resources.gresource" 103 | } 104 | 105 | @test "SOURCE_DIR argument works properly with absolute paths" { 106 | cd source-dir-absolute 107 | 108 | rm -rf build 109 | mkdir build 110 | cd build 111 | cmake .. 112 | make 113 | cd .. 114 | 115 | [ -f "build/resources.gresource.xml" ] 116 | [ -f "build/resources.gresource" ] 117 | 118 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 119 | diff "build/resources.gresource" "snapshots/resources.gresource" 120 | } 121 | 122 | @test "STRIPBLANKS_ALL works" { 123 | cd stripblanks-all 124 | 125 | rm -rf build 126 | mkdir build 127 | cd build 128 | cmake .. 129 | make 130 | cd .. 131 | 132 | [ -f "build/resources.gresource.xml" ] 133 | [ -f "build/resources.gresource" ] 134 | 135 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 136 | diff "build/resources.gresource" "snapshots/resources.gresource" 137 | } 138 | 139 | @test "TOPIXDATA_ALL works" { 140 | cd topixdata-all 141 | 142 | rm -rf build 143 | mkdir build 144 | cd build 145 | cmake .. 146 | make 147 | cd .. 148 | 149 | [ -f "build/resources.gresource.xml" ] 150 | [ -f "build/resources.gresource" ] 151 | 152 | diff "build/resources.gresource.xml" "snapshots/resources.gresource.xml" 153 | diff "build/resources.gresource" "snapshots/resources.gresource" 154 | } 155 | -------------------------------------------------------------------------------- /macros/GenerateGXML.cmake: -------------------------------------------------------------------------------- 1 | include(CMakeParseArguments) 2 | 3 | # Generates the resource XML controlling file from resource list (and saves it 4 | # to xml_path). It's not recommended to use this function directly, since it 5 | # doesn't handle invalid arguments. It is used by the function 6 | # COMPILE_GRESOURCES() to create a custom command, so that this function is 7 | # invoked at build-time in script mode from CMake. 8 | function(GENERATE_GXML xml_path) 9 | # Available options: 10 | # COMPRESS_ALL, NO_COMPRESS_ALL Overrides the COMPRESS flag in all 11 | # registered resources. 12 | # STRIPBLANKS_ALL, NO_STRIPBLANKS_ALL Overrides the STRIPBLANKS flag in all 13 | # registered resources. 14 | # TOPIXDATA_ALL, NO_TOPIXDATA_ALL Overrides the TOPIXDATA flag in all 15 | # registered resources. 16 | set(GXML_OPTIONS COMPRESS_ALL NO_COMPRESS_ALL 17 | STRIPBLANKS_ALL NO_STRIPBLANKS_ALL 18 | TOPIXDATA_ALL NO_TOPIXDATA_ALL) 19 | 20 | # Available one value options: 21 | # PREFIX Overrides the resource prefix that is prepended to each 22 | # relative file name in registered resources. 23 | set(GXML_ONEVALUEARGS PREFIX) 24 | 25 | # Available multi-value options: 26 | # RESOURCES The list of resource files. Whether absolute or relative path is 27 | # equal, absolute paths are stripped down to relative ones. If the 28 | # absolute path is not inside the given base directory SOURCE_DIR 29 | # or CMAKE_CURRENT_SOURCE_DIR (if SOURCE_DIR is not overriden), 30 | # this function aborts. 31 | set(GXML_MULTIVALUEARGS RESOURCES) 32 | 33 | # Parse the arguments. 34 | cmake_parse_arguments(GXML_ARG 35 | "${GXML_OPTIONS}" 36 | "${GXML_ONEVALUEARGS}" 37 | "${GXML_MULTIVALUEARGS}" 38 | "${ARGN}") 39 | 40 | # Variable to store the double-quote (") string. Since escaping 41 | # double-quotes in strings is not possible we need a helper variable that 42 | # does this job for us. 43 | set(Q \") 44 | 45 | # Process resources and generate XML file. 46 | # Begin with the XML header and header nodes. 47 | set(GXML_XML_FILE "") 48 | set(GXML_XML_FILE "${GXML_XML_FILE}") 59 | 60 | # Process each resource. 61 | foreach(res ${GXML_ARG_RESOURCES}) 62 | if ("${res}" STREQUAL "COMPRESS") 63 | set(GXML_COMPRESSION_FLAG ON) 64 | elseif ("${res}" STREQUAL "STRIPBLANKS") 65 | set(GXML_STRIPBLANKS_FLAG ON) 66 | elseif ("${res}" STREQUAL "TOPIXDATA") 67 | set(GXML_TOPIXDATA_FLAG ON) 68 | else() 69 | # The file name. 70 | set(GXML_RESOURCE_PATH "${res}") 71 | 72 | # Append to real resource file dependency list. 73 | list(APPEND GXML_RESOURCES_DEPENDENCIES ${GXML_RESOURCE_PATH}) 74 | 75 | # Assemble node. 76 | set(GXML_RES_LINE "${GXML_RESOURCE_PATH}") 104 | 105 | # Append to file string. 106 | set(GXML_XML_FILE "${GXML_XML_FILE}${GXML_RES_LINE}") 107 | 108 | # Unset variables. 109 | unset(GXML_COMPRESSION_FLAG) 110 | unset(GXML_STRIPBLANKS_FLAG) 111 | unset(GXML_TOPIXDATA_FLAG) 112 | endif() 113 | 114 | endforeach() 115 | 116 | # Append closing nodes. 117 | set(GXML_XML_FILE "${GXML_XML_FILE}") 118 | 119 | # Use "file" function to generate XML controlling file. 120 | get_filename_component(xml_path_only_name "${xml_path}" NAME) 121 | file(WRITE ${xml_path} ${GXML_XML_FILE}) 122 | 123 | endfunction() 124 | 125 | -------------------------------------------------------------------------------- /tests/create-c-code/snapshots/resources.c: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6)) 4 | # define SECTION __attribute__ ((section (".gresource.resources"), aligned (8))) 5 | #else 6 | # define SECTION 7 | #endif 8 | 9 | #ifdef _MSC_VER 10 | static const SECTION union { const guint8 data[282]; const double alignment; void * const ptr;} resources_resource_data = { { 11 | 0107, 0126, 0141, 0162, 0151, 0141, 0156, 0164, 0000, 0000, 0000, 0000, 0000, 0000, 0000, 0000, 12 | 0030, 0000, 0000, 0000, 0220, 0000, 0000, 0000, 0000, 0000, 0000, 0050, 0004, 0000, 0000, 0000, 13 | 0000, 0000, 0000, 0000, 0001, 0000, 0000, 0000, 0002, 0000, 0000, 0000, 0004, 0000, 0000, 0000, 14 | 0324, 0265, 0002, 0000, 0377, 0377, 0377, 0377, 0220, 0000, 0000, 0000, 0001, 0000, 0114, 0000, 15 | 0224, 0000, 0000, 0000, 0230, 0000, 0000, 0000, 0275, 0000, 0142, 0053, 0002, 0000, 0000, 0000, 16 | 0230, 0000, 0000, 0000, 0015, 0000, 0166, 0000, 0250, 0000, 0000, 0000, 0320, 0000, 0000, 0000, 17 | 0166, 0005, 0066, 0033, 0000, 0000, 0000, 0000, 0320, 0000, 0000, 0000, 0007, 0000, 0114, 0000, 18 | 0330, 0000, 0000, 0000, 0340, 0000, 0000, 0000, 0076, 0031, 0164, 0053, 0002, 0000, 0000, 0000, 19 | 0340, 0000, 0000, 0000, 0015, 0000, 0166, 0000, 0360, 0000, 0000, 0000, 0031, 0001, 0000, 0000, 20 | 0057, 0000, 0000, 0000, 0002, 0000, 0000, 0000, 0162, 0145, 0163, 0157, 0165, 0162, 0143, 0145, 21 | 0061, 0056, 0164, 0170, 0164, 0000, 0000, 0000, 0030, 0000, 0000, 0000, 0000, 0000, 0000, 0000, 22 | 0164, 0150, 0151, 0163, 0040, 0151, 0163, 0040, 0141, 0040, 0164, 0145, 0163, 0164, 0040, 0162, 23 | 0145, 0163, 0157, 0165, 0162, 0143, 0145, 0012, 0000, 0000, 0050, 0165, 0165, 0141, 0171, 0051, 24 | 0141, 0163, 0163, 0145, 0164, 0163, 0057, 0000, 0001, 0000, 0000, 0000, 0003, 0000, 0000, 0000, 25 | 0162, 0145, 0163, 0157, 0165, 0162, 0143, 0145, 0062, 0056, 0164, 0170, 0164, 0000, 0000, 0000, 26 | 0031, 0000, 0000, 0000, 0000, 0000, 0000, 0000, 0164, 0150, 0151, 0163, 0040, 0151, 0163, 0040, 27 | 0164, 0145, 0163, 0164, 0040, 0162, 0145, 0163, 0157, 0165, 0162, 0143, 0145, 0040, 0043, 0062, 28 | 0012, 0000, 0000, 0050, 0165, 0165, 0141, 0171, 0051 29 | } }; 30 | #else /* _MSC_VER */ 31 | static const SECTION union { const guint8 data[282]; const double alignment; void * const ptr;} resources_resource_data = { 32 | "\107\126\141\162\151\141\156\164\000\000\000\000\000\000\000\000" 33 | "\030\000\000\000\220\000\000\000\000\000\000\050\004\000\000\000" 34 | "\000\000\000\000\001\000\000\000\002\000\000\000\004\000\000\000" 35 | "\324\265\002\000\377\377\377\377\220\000\000\000\001\000\114\000" 36 | "\224\000\000\000\230\000\000\000\275\000\142\053\002\000\000\000" 37 | "\230\000\000\000\015\000\166\000\250\000\000\000\320\000\000\000" 38 | "\166\005\066\033\000\000\000\000\320\000\000\000\007\000\114\000" 39 | "\330\000\000\000\340\000\000\000\076\031\164\053\002\000\000\000" 40 | "\340\000\000\000\015\000\166\000\360\000\000\000\031\001\000\000" 41 | "\057\000\000\000\002\000\000\000\162\145\163\157\165\162\143\145" 42 | "\061\056\164\170\164\000\000\000\030\000\000\000\000\000\000\000" 43 | "\164\150\151\163\040\151\163\040\141\040\164\145\163\164\040\162" 44 | "\145\163\157\165\162\143\145\012\000\000\050\165\165\141\171\051" 45 | "\141\163\163\145\164\163\057\000\001\000\000\000\003\000\000\000" 46 | "\162\145\163\157\165\162\143\145\062\056\164\170\164\000\000\000" 47 | "\031\000\000\000\000\000\000\000\164\150\151\163\040\151\163\040" 48 | "\164\145\163\164\040\162\145\163\157\165\162\143\145\040\043\062" 49 | "\012\000\000\050\165\165\141\171\051" }; 50 | #endif /* !_MSC_VER */ 51 | 52 | static GStaticResource static_resource = { resources_resource_data.data, sizeof (resources_resource_data.data) - 1 /* nul terminator */, NULL, NULL, NULL }; 53 | 54 | G_MODULE_EXPORT 55 | GResource *resources_get_resource (void); 56 | GResource *resources_get_resource (void) 57 | { 58 | return g_static_resource_get_resource (&static_resource); 59 | } 60 | /* 61 | If G_HAS_CONSTRUCTORS is true then the compiler support *both* constructors and 62 | destructors, in a usable way, including e.g. on library unload. If not you're on 63 | your own. 64 | 65 | Some compilers need #pragma to handle this, which does not work with macros, 66 | so the way you need to use this is (for constructors): 67 | 68 | #ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA 69 | #pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(my_constructor) 70 | #endif 71 | G_DEFINE_CONSTRUCTOR(my_constructor) 72 | static void my_constructor(void) { 73 | ... 74 | } 75 | 76 | */ 77 | 78 | #ifndef __GTK_DOC_IGNORE__ 79 | 80 | #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7) 81 | 82 | #define G_HAS_CONSTRUCTORS 1 83 | 84 | #define G_DEFINE_CONSTRUCTOR(_func) static void __attribute__((constructor)) _func (void); 85 | #define G_DEFINE_DESTRUCTOR(_func) static void __attribute__((destructor)) _func (void); 86 | 87 | #elif defined (_MSC_VER) && (_MSC_VER >= 1500) 88 | /* Visual studio 2008 and later has _Pragma */ 89 | 90 | #include 91 | 92 | #define G_HAS_CONSTRUCTORS 1 93 | 94 | /* We do some weird things to avoid the constructors being optimized 95 | * away on VS2015 if WholeProgramOptimization is enabled. First we 96 | * make a reference to the array from the wrapper to make sure its 97 | * references. Then we use a pragma to make sure the wrapper function 98 | * symbol is always included at the link stage. Also, the symbols 99 | * need to be extern (but not dllexport), even though they are not 100 | * really used from another object file. 101 | */ 102 | 103 | /* We need to account for differences between the mangling of symbols 104 | * for x86 and x64/ARM/ARM64 programs, as symbols on x86 are prefixed 105 | * with an underscore but symbols on x64/ARM/ARM64 are not. 106 | */ 107 | #ifdef _M_IX86 108 | #define G_MSVC_SYMBOL_PREFIX "_" 109 | #else 110 | #define G_MSVC_SYMBOL_PREFIX "" 111 | #endif 112 | 113 | #define G_DEFINE_CONSTRUCTOR(_func) G_MSVC_CTOR (_func, G_MSVC_SYMBOL_PREFIX) 114 | #define G_DEFINE_DESTRUCTOR(_func) G_MSVC_DTOR (_func, G_MSVC_SYMBOL_PREFIX) 115 | 116 | #define G_MSVC_CTOR(_func,_sym_prefix) \ 117 | static void _func(void); \ 118 | extern int (* _array ## _func)(void); \ 119 | int _func ## _wrapper(void) { _func(); g_slist_find (NULL, _array ## _func); return 0; } \ 120 | __pragma(comment(linker,"/include:" _sym_prefix # _func "_wrapper")) \ 121 | __pragma(section(".CRT$XCU",read)) \ 122 | __declspec(allocate(".CRT$XCU")) int (* _array ## _func)(void) = _func ## _wrapper; 123 | 124 | #define G_MSVC_DTOR(_func,_sym_prefix) \ 125 | static void _func(void); \ 126 | extern int (* _array ## _func)(void); \ 127 | int _func ## _constructor(void) { atexit (_func); g_slist_find (NULL, _array ## _func); return 0; } \ 128 | __pragma(comment(linker,"/include:" _sym_prefix # _func "_constructor")) \ 129 | __pragma(section(".CRT$XCU",read)) \ 130 | __declspec(allocate(".CRT$XCU")) int (* _array ## _func)(void) = _func ## _constructor; 131 | 132 | #elif defined (_MSC_VER) 133 | 134 | #define G_HAS_CONSTRUCTORS 1 135 | 136 | /* Pre Visual studio 2008 must use #pragma section */ 137 | #define G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA 1 138 | #define G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA 1 139 | 140 | #define G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(_func) \ 141 | section(".CRT$XCU",read) 142 | #define G_DEFINE_CONSTRUCTOR(_func) \ 143 | static void _func(void); \ 144 | static int _func ## _wrapper(void) { _func(); return 0; } \ 145 | __declspec(allocate(".CRT$XCU")) static int (*p)(void) = _func ## _wrapper; 146 | 147 | #define G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(_func) \ 148 | section(".CRT$XCU",read) 149 | #define G_DEFINE_DESTRUCTOR(_func) \ 150 | static void _func(void); \ 151 | static int _func ## _constructor(void) { atexit (_func); return 0; } \ 152 | __declspec(allocate(".CRT$XCU")) static int (* _array ## _func)(void) = _func ## _constructor; 153 | 154 | #elif defined(__SUNPRO_C) 155 | 156 | /* This is not tested, but i believe it should work, based on: 157 | * http://opensource.apple.com/source/OpenSSL098/OpenSSL098-35/src/fips/fips_premain.c 158 | */ 159 | 160 | #define G_HAS_CONSTRUCTORS 1 161 | 162 | #define G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA 1 163 | #define G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA 1 164 | 165 | #define G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(_func) \ 166 | init(_func) 167 | #define G_DEFINE_CONSTRUCTOR(_func) \ 168 | static void _func(void); 169 | 170 | #define G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(_func) \ 171 | fini(_func) 172 | #define G_DEFINE_DESTRUCTOR(_func) \ 173 | static void _func(void); 174 | 175 | #else 176 | 177 | /* constructors not supported for this compiler */ 178 | 179 | #endif 180 | 181 | #endif /* __GTK_DOC_IGNORE__ */ 182 | 183 | #ifdef G_HAS_CONSTRUCTORS 184 | 185 | #ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA 186 | #pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor) 187 | #endif 188 | G_DEFINE_CONSTRUCTOR(resource_constructor) 189 | #ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA 190 | #pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor) 191 | #endif 192 | G_DEFINE_DESTRUCTOR(resource_destructor) 193 | 194 | #else 195 | #warning "Constructor not supported on this compiler, linking in resources will not work" 196 | #endif 197 | 198 | static void resource_constructor (void) 199 | { 200 | g_static_resource_init (&static_resource); 201 | } 202 | 203 | static void resource_destructor (void) 204 | { 205 | g_static_resource_fini (&static_resource); 206 | } 207 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GCR_CMake 2 | A CMake extension supporting the **glib-compile-resources** tool. 3 | 4 | About 5 | ----- 6 | 7 | Inspired from the macros for Vala that I used to build a GTK application, I came 8 | to the point where I needed resources for it. For that purpose the 9 | **glib-compile-resources** tool seemed to be the right choice, but the extra XML 10 | file you need to write bothered me. If I add a resource I don't want to mark it 11 | explicitly in CMake and in the XML file. So I came up with this macro that does 12 | everything for you. You just add your resource to a resource list (with 13 | eventually some attributes like compression) and invoke the resource compilation 14 | function. It generates the XML automatically for you. Quite simple, isn't it? 15 | 16 | Clone 17 | ----- 18 | 19 | To clone this repository, just type 20 | 21 | ```shell 22 | git clone https://github.com/Makman2/GCR_CMake 23 | ``` 24 | 25 | Usage 26 | ----- 27 | 28 | Just add the macro directory to your `CMAKE_MODULE_PATH`, include the CMake 29 | file and you are ready to go. 30 | 31 | ```cmake 32 | list(APPEND CMAKE_MODULE_PATH 33 | ${PATH_TO_GCR_CMAKE_PARENT_DIR}/GCR_CMake/macros) 34 | 35 | include(GlibCompileResourcesSupport) 36 | ``` 37 | 38 | Reference 39 | --------- 40 | 41 | The resource compiling macro is quite powerful and handles as much errors as 42 | possible to make error-finding easier. The function is defined as follows: 43 | 44 | ``` 45 | compile_gresources( 46 | 47 | [TYPE output_type] 48 | [TARGET output_name] 49 | [RESOURCES [resources...]] 50 | [OPTIONS [command_line_options...]] 51 | [PREFIX resource_prefix] 52 | [C_PREFIX c_names_prefix] 53 | [SOURCE_DIR resource_directory] 54 | [COMPRESS_ALL] [NO_COMPRESS_ALL] 55 | [STRIPBLANKS_ALL] [NO_STRIPBLANKS_ALL] 56 | [TOPIXDATA_ALL] [NO_TOPIXDATA_ALL]) 57 | ``` 58 | 59 | - ***output*** 60 | 61 | The variable name where to set the output file names. Pass this variable to a 62 | target as a dependency (i.e. `add_custom_target`). 63 | 64 | - ***xml_out*** 65 | 66 | The variable name where to store the output file name of the intermediately 67 | generated gresource-XML-file. 68 | 69 | - **TYPE** ***output_type*** 70 | 71 | The resource type to generate. Valid values are `EMBED_C`, `EMBED_H`, `BUNDLE` 72 | or `AUTO`. Anything else will default to `AUTO`. 73 | 74 | - `EMBED_C`: Generate a C code file that can be compiled with your program. 75 | 76 | - `EMBED_H`: Generate a header file to include in your program. 77 | 78 | - `BUNDLE`: Generates a resource disk file to load at runtime. 79 | 80 | - `AUTO` (or anything else): Extract mode from file ending specified in 81 | `TARGET`. 82 | 83 | If `TARGET` contains 84 | an invalid file or file ending not detectable, the function results in a 85 | **FATAL_ERROR**. 86 | 87 | Recognized file formats are: *.gresource*, *.c*, *.h*. 88 | 89 | - **TARGET** ***output_name*** 90 | 91 | Overrides the default output file name. If not specified (and not 92 | `AUTO`-**TYPE** is set) the output name is *resources.[type-ending]*. 93 | 94 | - **RESOURCES** ***[resources...]*** 95 | 96 | The resource list to process. Each resource must be a relative path inside the 97 | source directory. Each file can be preceded with resource flags. 98 | 99 | - `COMPRESS` flag 100 | 101 | Compress the following file. Effectively sets the attribute *compressed* in 102 | the XML file to true. 103 | 104 | - `STRIPBLANKS` flag 105 | 106 | Strip whitespace characters in XML files. Sets the *preprocess* attribute in 107 | XML with *xml-stripblanks* (requires XMLLint). 108 | 109 | - `TOPIXDATA` flag 110 | 111 | Generates a pixdata ready to use in Gdk. Sets the *preprocess* attribute in 112 | XML with *to-pixdata*. 113 | 114 | Note: Using `STRIPBLANKS` and `TOPIXDATA` together results in a 115 | **FATAL_ERROR**. 116 | 117 | - **OPTIONS** ***command_line_options*** 118 | 119 | Extra command line arguments passed to **glib_compile_resources**. For example 120 | `--internal` or `--manual-register`. 121 | 122 | - **PREFIX** ***resource_prefix*** 123 | 124 | Overrides the resource prefix. The resource entries get inside the XML a 125 | prefix that is prepended to each resource file and represents as a whole the 126 | resource path. 127 | 128 | - **C_PREFIX** ***c_names_prefix*** 129 | 130 | Specifies the prefix used for the C identifiers in the code generated when 131 | *EMBED_C* or *EMBED_H* are specified for *TYPE*. 132 | 133 | - **SOURCE_DIR** ***resource_directory*** 134 | 135 | The source directory where the resource files are. If not overridden, this 136 | value is set to `CMAKE_CURRENT_LIST_DIR`. 137 | 138 | - **COMPRESS_ALL**, **NO_COMPRESS_ALL** 139 | 140 | Overrides the `COMPRESS` flag in all resources. If **COMPRESS_ALL** is 141 | specified, `COMPRESS` is set everywhere regardless of the specified resource 142 | flags. If **NO_COMPRESS_ALL** is specified, compression is deactivated in all 143 | resources. 144 | 145 | Specifying **COMPRESS_ALL** and **NO_COMPRESS_ALL** together results in a 146 | **FATAL_ERROR**. 147 | 148 | - **STRIPBLANKS_ALL**, **NO_STRIPBLANKS_ALL** 149 | 150 | Overrides the `STRIPBLANKS` flag in all resources. If **STRIPBLANKS_ALL** is 151 | specified, `STRIPBLANKS` is set everywhere regardless of the specified 152 | resource flags. If **NO_STRIPBLANKS_ALL** is specified, stripping away 153 | whitespaces is deactivated in all resources. 154 | 155 | Specifying **STRIPBLANKS_ALL** and **NO_STRIPBLANKS_ALL** together results in 156 | a **FATAL_ERROR**. 157 | 158 | - **TOPIXDATA_ALL**, **NO_TOPIXDATA_ALL** 159 | 160 | Overrides the `TOPIXDATA` flag in all resources. If **TOPIXDATA_ALL** is 161 | specified, `TOPIXDATA` is set everywhere regardless of the specified resource 162 | flags. If **NO_TOPIXDATA_ALL** is specified, converting into pixbufs is 163 | deactivated in all resources. 164 | 165 | Specifying **TOPIXDATA_ALL** and **NO_TOPIXDATA_ALL** together results in a 166 | **FATAL_ERROR**. 167 | 168 | Kickstart 169 | --------- 170 | 171 | This is a quick start guide to provide you an easy start with this macro. 172 | 173 | Starting with a simple example: 174 | 175 | ```cmake 176 | set(RESOURCE_LIST 177 | info.txt 178 | img/image1.jpg 179 | img/image2.jpg 180 | data.xml) 181 | 182 | compile_gresources(RESOURCE_FILE 183 | XML_OUT 184 | TYPE BUNDLE 185 | RESOURCES ${RESOURCE_LIST}) 186 | ``` 187 | 188 | What does this snippet do? First it sets some resource files to pack into a 189 | resource file. They are located in the source directory passed to CMake at 190 | invocation (`CMAKE_CURRENT_LIST_DIR`). 191 | After that we compile the resources. Means we generate a *.gresource.xml*-file 192 | (it's path is put inside the `XML_OUT` variable) automatically from our 193 | `RESOURCE_LIST` and create a custom command that compiles the generated 194 | *.gresource.xml*-file with the provided resources into a resource bundle. Since 195 | no specific output file is specified via **TARGET** the output file is placed 196 | into the `CMAKE_CURENT_BINARY_DIR` with the name *resources.gresource*. The 197 | first argument `RESOURCE_FILE` is a variable that is filled with the output file 198 | name, so with *resources.gresource* inside the build directory. This variable is 199 | helpful to create makefile targets (or to process the output file differently). 200 | 201 | So here comes a full *CMakeLists.txt* that creates the resources from before. 202 | 203 | ```cmake 204 | # Minimum support is guaranteed for CMake 2.8. Everything below needs to be 205 | # tested. 206 | cmake_minimum_required(2.8) 207 | 208 | project(MyResourceFile) 209 | 210 | # Include the extension module. 211 | list(APPEND CMAKE_MODULE_PATH 212 | ${PATH_TO_GCR_CMAKE_PARENT_DIR}/GCR_CMake/macros) 213 | 214 | include(GlibCompileResourcesSupport) 215 | 216 | # Set the resources to bundle. 217 | set(RESOURCE_LIST 218 | info.txt 219 | img/image1.jpg 220 | img/image2.jpg 221 | data.xml) 222 | 223 | # Compile the resources. 224 | compile_gresources(RESOURCE_FILE 225 | XML_OUT 226 | TYPE BUNDLE 227 | RESOURCES ${RESOURCE_LIST}) 228 | 229 | # Add a custom target to the makefile. Now make builds our resource file. 230 | # It depends on the output RESOURCE_FILE. 231 | add_custom_target(resource ALL DEPENDS ${RESOURCE_FILE}) 232 | ``` 233 | 234 | A nice feature of the `compile_gresources`-macro is that it supports 235 | individually setting flags on the resources. So we can extend our resource list 236 | like that: 237 | 238 | ```cmake 239 | set(RESOURCE_LIST 240 | info.txt 241 | COMPRESS img/image1.jpg 242 | COMPRESS img/image2.jpg 243 | STRIPBLANKS data.xml) 244 | ``` 245 | 246 | This resource list not only simply includes the resources, it specifies also 247 | that the two images should be compressed and in *data.xml* the whitespaces 248 | should be removed. This resource list will include the same files but will 249 | preprocess some of them. 250 | 251 | Very handy are the `COMPRESS_ALL`, `STRIPBLANKS_ALL` or `TOPIXDATA_ALL` 252 | parameters (and their `NO_`-equivalents). If you are too lazy to write before 253 | every file the flag, just invoke `compile_gresources` with them. 254 | 255 | ```cmake 256 | # Compile the resources. Compresses all files regardless if you specified it 257 | # explicitly or not. 258 | compile_gresources(RESOURCE_FILE 259 | XML_OUT 260 | TYPE BUNDLE 261 | RESOURCES ${RESOURCE_LIST} 262 | COMPRESS_ALL) 263 | ``` 264 | 265 | So that's a short introduction into the operating mode of the 266 | `compile-gresources` macro. 267 | -------------------------------------------------------------------------------- /macros/CompileGResources.cmake: -------------------------------------------------------------------------------- 1 | include(CMakeParseArguments) 2 | 3 | # Path to this file. 4 | set(GCR_CMAKE_MACRO_DIR ${CMAKE_CURRENT_LIST_DIR}) 5 | 6 | # Compiles a gresource resource file from given resource files. Automatically 7 | # creates the XML controlling file. 8 | # The type of resource to generate (header, c-file or bundle) is automatically 9 | # determined from TARGET file ending, if no TYPE is explicitly specified. 10 | # The output file is stored in the provided variable "output". 11 | # "xml_out" contains the variable where to output the XML path. Can be used to 12 | # create custom targets or doing postprocessing. 13 | # If you want to use preprocessing, you need to manually check the existence 14 | # of the tools you use. This function doesn't check this for you, it just 15 | # generates the XML file. glib-compile-resources will then throw a 16 | # warning/error. 17 | function(COMPILE_GRESOURCES output xml_out) 18 | # Available options: 19 | # COMPRESS_ALL, NO_COMPRESS_ALL Overrides the COMPRESS flag in all 20 | # registered resources. 21 | # STRIPBLANKS_ALL, NO_STRIPBLANKS_ALL Overrides the STRIPBLANKS flag in all 22 | # registered resources. 23 | # TOPIXDATA_ALL, NO_TOPIXDATA_ALL Overrides the TOPIXDATA flag in all 24 | # registered resources. 25 | set(CG_OPTIONS COMPRESS_ALL NO_COMPRESS_ALL 26 | STRIPBLANKS_ALL NO_STRIPBLANKS_ALL 27 | TOPIXDATA_ALL NO_TOPIXDATA_ALL) 28 | 29 | # Available one value options: 30 | # TYPE Type of resource to create. Valid options are: 31 | # EMBED_C: A C-file that can be compiled with your project. 32 | # EMBED_H: A header that can be included into your project. 33 | # BUNDLE: Generates a resource bundle file that can be loaded 34 | # at runtime. 35 | # AUTO: Determine from target file ending. Need to specify 36 | # target argument. 37 | # PREFIX Overrides the resource prefix that is prepended to each 38 | # relative file name in registered resources. 39 | # C_PREFIX Specifies the prefix used for the C identifiers in the code generated 40 | # when EMBED_C or EMBED_H are specified for TYPE. 41 | # SOURCE_DIR Overrides the resources base directory to search for resources. 42 | # By default this is set to CMAKE_CURRENT_LIST_DIR. 43 | # TARGET Overrides the name of the output file/-s. Normally the output 44 | # names from the glib-compile-resources tool are taken. 45 | set(CG_ONEVALUEARGS TYPE PREFIX C_PREFIX SOURCE_DIR TARGET) 46 | 47 | # Available multi-value options: 48 | # RESOURCES The list of resource files. Whether absolute or relative path is 49 | # equal, absolute paths are stripped down to relative ones. If the 50 | # absolute path is not inside the given base directory SOURCE_DIR 51 | # or CMAKE_CURRENT_SOURCE_DIR (if SOURCE_DIR is not overriden), 52 | # this function aborts. 53 | # OPTIONS Extra command line options passed to glib-compile-resources. 54 | set(CG_MULTIVALUEARGS RESOURCES OPTIONS) 55 | 56 | # Parse the arguments. 57 | cmake_parse_arguments(CG_ARG 58 | "${CG_OPTIONS}" 59 | "${CG_ONEVALUEARGS}" 60 | "${CG_MULTIVALUEARGS}" 61 | "${ARGN}") 62 | 63 | # Variable to store the double-quote (") string. Since escaping 64 | # double-quotes in strings is not possible we need a helper variable that 65 | # does this job for us. 66 | set(Q \") 67 | 68 | # Check invocation validity with the _UNPARSED_ARGUMENTS variable. 69 | # If other not recognized parameters were passed, throw error. 70 | if (CG_ARG_UNPARSED_ARGUMENTS) 71 | set(CG_WARNMSG "Invocation of COMPILE_GRESOURCES with unrecognized") 72 | set(CG_WARNMSG "${CG_WARNMSG} parameters. Parameters are:") 73 | set(CG_WARNMSG "${CG_WARNMSG} ${CG_ARG_UNPARSED_ARGUMENTS}.") 74 | message(WARNING ${CG_WARNMSG}) 75 | endif() 76 | 77 | # Check invocation validity depending on generation mode (EMBED_C, EMBED_H 78 | # or BUNDLE). 79 | if ("${CG_ARG_TYPE}" STREQUAL "EMBED_C") 80 | # EMBED_C mode, output compilable C-file. 81 | list(APPEND CG_GENERATE_COMMAND_LINE --generate-source) 82 | if (NOT "${CG_ARG_C_PREFIX}" STREQUAL "") 83 | list(APPEND CG_GENERATE_COMMAND_LINE --c-name "${CG_ARG_C_PREFIX}") 84 | endif() 85 | set(CG_TARGET_FILE_ENDING "c") 86 | elseif ("${CG_ARG_TYPE}" STREQUAL "EMBED_H") 87 | # EMBED_H mode, output includable header file. 88 | list(APPEND CG_GENERATE_COMMAND_LINE --generate-header) 89 | if (NOT "${CG_ARG_C_PREFIX}" STREQUAL "") 90 | list(APPEND CG_GENERATE_COMMAND_LINE --c-name "${CG_ARG_C_PREFIX}") 91 | endif() 92 | set(CG_TARGET_FILE_ENDING "h") 93 | elseif ("${CG_ARG_TYPE}" STREQUAL "BUNDLE") 94 | # BUNDLE mode, output resource bundle. Don't do anything since 95 | # glib-compile-resources outputs a bundle when not specifying 96 | # something else. 97 | set(CG_TARGET_FILE_ENDING "gresource") 98 | if (NOT "${CG_ARG_C_PREFIX}" STREQUAL "") 99 | message(WARNING "Superfluously provided C_PREFIX=${CG_ARG_C_PREFIX} for BUNDLE.") 100 | endif() 101 | else() 102 | # Everything else is AUTO mode, determine from target file ending. 103 | if (CG_ARG_TARGET) 104 | list(APPEND CG_GENERATE_COMMAND_LINE --generate) 105 | else() 106 | set(CG_ERRMSG "AUTO mode given, but no target specified. Can't") 107 | set(CG_ERRMSG "${CG_ERRMSG} determine output type. In function") 108 | set(CG_ERRMSG "${CG_ERRMSG} COMPILE_GRESOURCES.") 109 | message(FATAL_ERROR ${CG_ERRMSG}) 110 | endif() 111 | endif() 112 | 113 | # Check flag validity. 114 | if (CG_ARG_COMPRESS_ALL AND CG_ARG_NO_COMPRESS_ALL) 115 | set(CG_ERRMSG "COMPRESS_ALL and NO_COMPRESS_ALL simultaneously set. In") 116 | set(CG_ERRMSG "${CG_ERRMSG} function COMPILE_GRESOURCES.") 117 | message(FATAL_ERROR ${CG_ERRMSG}) 118 | endif() 119 | if (CG_ARG_STRIPBLANKS_ALL AND CG_ARG_NO_STRIPBLANKS_ALL) 120 | set(CG_ERRMSG "STRIPBLANKS_ALL and NO_STRIPBLANKS_ALL simultaneously") 121 | set(CG_ERRMSG "${CG_ERRMSG} set. In function COMPILE_GRESOURCES.") 122 | message(FATAL_ERROR ${CG_ERRMSG}) 123 | endif() 124 | if (CG_ARG_TOPIXDATA_ALL AND CG_ARG_NO_TOPIXDATA_ALL) 125 | set(CG_ERRMSG "TOPIXDATA_ALL and NO_TOPIXDATA_ALL simultaneously set.") 126 | set(CG_ERRMSG "${CG_ERRMSG} In function COMPILE_GRESOURCES.") 127 | message(FATAL_ERROR ${CG_ERRMSG}) 128 | endif() 129 | 130 | # Check if there are any resources. 131 | if (NOT CG_ARG_RESOURCES) 132 | set(CG_ERRMSG "No resource files to process. In function") 133 | set(CG_ERRMSG "${CG_ERRMSG} COMPILE_GRESOURCES.") 134 | message(FATAL_ERROR ${CG_ERRMSG}) 135 | endif() 136 | 137 | # If source directory is not set, default to working directory. 138 | if (CG_ARG_SOURCE_DIR) 139 | get_filename_component(CG_ARG_SOURCE_DIR "${CG_ARG_SOURCE_DIR}" 140 | REALPATH BASE_DIR "${CMAKE_CURRENT_LIST_DIR}") 141 | else() 142 | set(CG_ARG_SOURCE_DIR "${CMAKE_CURRENT_LIST_DIR}") 143 | endif() 144 | 145 | # Extract all dependencies for targets from resource list. 146 | foreach(res ${CG_ARG_RESOURCES}) 147 | if (NOT(("${res}" STREQUAL "COMPRESS") OR 148 | ("${res}" STREQUAL "STRIPBLANKS") OR 149 | ("${res}" STREQUAL "TOPIXDATA"))) 150 | 151 | list(APPEND CG_RESOURCES_DEPENDENCIES "${CG_ARG_SOURCE_DIR}/${res}") 152 | endif() 153 | endforeach() 154 | 155 | # Construct .gresource.xml path. 156 | set(CG_XML_FILE_PATH "${CMAKE_CURRENT_BINARY_DIR}/resources.gresource.xml") 157 | 158 | # Generate gresources XML target. 159 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 160 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_OUTPUT=${Q}${CG_XML_FILE_PATH}${Q}") 161 | if(CG_ARG_COMPRESS_ALL) 162 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 163 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_COMPRESS_ALL=ON") 164 | endif() 165 | if(CG_ARG_NO_COMPRESS_ALL) 166 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 167 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_NO_COMPRESS_ALL=ON") 168 | endif() 169 | if(CG_ARG_STRIPBLANKS_ALL) 170 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 171 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_STRIPBLANKS_ALL=ON") 172 | endif() 173 | if(CG_ARG_NO_STRIPBLANKS_ALL) 174 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 175 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_NO_STRIPBLANKS_ALL=ON") 176 | endif() 177 | if(CG_ARG_TOPIXDATA_ALL) 178 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 179 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_TOPIXDATA_ALL=ON") 180 | endif() 181 | if(CG_ARG_NO_TOPIXDATA_ALL) 182 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 183 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_NO_TOPIXDATA_ALL=ON") 184 | endif() 185 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 186 | list(APPEND CG_CMAKE_SCRIPT_ARGS "GXML_PREFIX=${Q}${CG_ARG_PREFIX}${Q}") 187 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-D") 188 | list(APPEND CG_CMAKE_SCRIPT_ARGS 189 | "GXML_RESOURCES=${Q}${CG_ARG_RESOURCES}${Q}") 190 | list(APPEND CG_CMAKE_SCRIPT_ARGS "-P") 191 | list(APPEND CG_CMAKE_SCRIPT_ARGS 192 | "${Q}${GCR_CMAKE_MACRO_DIR}/BuildTargetScript.cmake${Q}") 193 | 194 | get_filename_component(CG_XML_FILE_PATH_ONLY_NAME 195 | "${CG_XML_FILE_PATH}" NAME) 196 | set(CG_XML_CUSTOM_COMMAND_COMMENT 197 | "Creating gresources XML file (${CG_XML_FILE_PATH_ONLY_NAME})") 198 | add_custom_command(OUTPUT ${CG_XML_FILE_PATH} 199 | COMMAND ${CMAKE_COMMAND} 200 | ARGS ${CG_CMAKE_SCRIPT_ARGS} 201 | DEPENDS ${CG_RESOURCES_DEPENDENCIES} 202 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 203 | COMMENT ${CG_XML_CUSTOM_COMMAND_COMMENT}) 204 | 205 | # Create target manually if not set (to make sure glib-compile-resources 206 | # doesn't change behaviour with it's naming standards). 207 | if (NOT CG_ARG_TARGET) 208 | set(CG_ARG_TARGET "${CMAKE_CURRENT_BINARY_DIR}/resources.${CG_TARGET_FILE_ENDING}") 209 | endif() 210 | 211 | # Add compilation target for resources. 212 | add_custom_command(OUTPUT ${CG_ARG_TARGET} 213 | COMMAND ${GLIB_COMPILE_RESOURCES_EXECUTABLE} 214 | ARGS 215 | ${CG_ARG_OPTIONS} 216 | --target ${CG_ARG_TARGET} 217 | --sourcedir ${CG_ARG_SOURCE_DIR} 218 | ${CG_GENERATE_COMMAND_LINE} 219 | ${CG_XML_FILE_PATH} 220 | VERBATIM 221 | MAIN_DEPENDENCY ${CG_XML_FILE_PATH} 222 | DEPENDS ${CG_RESOURCES_DEPENDENCIES} 223 | WORKING_DIRECTORY ${CMAKE_BUILD_DIR}) 224 | 225 | # Set output and XML_OUT to parent scope. 226 | set(${xml_out} ${CG_XML_FILE_PATH} PARENT_SCOPE) 227 | set(${output} ${CG_ARG_TARGET} PARENT_SCOPE) 228 | 229 | endfunction() 230 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------