pax_global_header00006660000000000000000000000064143536013260014515gustar00rootroot0000000000000052 comment=fc06b59d5bd5ee62afe820083d73b02ee29b2842 libxlsxwriter-RELEASE_1.1.5/000077500000000000000000000000001435360132600156035ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/.github/000077500000000000000000000000001435360132600171435ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/.github/FUNDING.yml000066400000000000000000000000411435360132600207530ustar00rootroot00000000000000custom: ["paypal.me/xlsxwriter"] libxlsxwriter-RELEASE_1.1.5/.github/ISSUE_TEMPLATE.md000066400000000000000000000043751435360132600216610ustar00rootroot00000000000000# libxlsxwriter: Reporting Bugs Here are some tips on reporting bugs in `libxlsxwriter`. ### Upgrade to the latest version of the library Upgrade to the latest version of the library since the bug you are reporting may already be fixed. Check the [Changes][changes] section of the documentation to see what has changed in the latest versions. [changes]: http://libxlsxwriter.github.io/changes.html You can check which version of `libxlsxwriter` that you are using by checking the `xlsxwriter.h` header file or by adding the following to your program: ```C #include #include "xlsxwriter.h" int main() { printf("Libxlsxwriter version = %s\n", lxw_version()); return 0; } ``` ### Read the documentation Read or search the `libxlsxwriter` [documentation][docs] to see if the issue you are encountering is already explained. [docs]: http://libxlsxwriter.github.io/index.html ### Look at the example programs There are many [examples programs][examples] in the distribution. Try to identify an example program that corresponds to your query and adapt it to use as a bug report. [examples]: http://libxlsxwriter.github.io/examples.html ### Tips for submitting a bug report 1. Describe the problem as clearly and as concisely as possible. 2. Include a sample program. This is probably the most important step. It is generally easier to describe a problem in code than in written prose. 3. The sample program should be as small as possible to demonstrate the problem. Don't copy and paste large non-relevant sections of your program. A sample bug report is shown below. This format helps analyze and respond to the bug report more quickly. > Subject: Issue with SOMETHING > > Greetings, > > I am using libxlsxwriter to do SOMETHING but it appears to do SOMETHING ELSE. > > I am using CC version X.Y.Z, OS = uname and libxlsxwriter x.y.z. > > Here is some code that demonstrates the problem: > > >```C >#include "xlsxwriter.h" > >int main() { > > lxw_workbook *workbook = workbook_new("bug_report.xlsx"); > lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL); > > worksheet_write_string(worksheet, 0, 0, "Hello", NULL); > worksheet_write_number(worksheet, 1, 0, 123, NULL); > > return workbook_close(workbook); >} >``` > libxlsxwriter-RELEASE_1.1.5/.github/PULL_REQUEST_TEMPLATE.md000066400000000000000000000067541435360132600227600ustar00rootroot00000000000000# libxlsxwriter: Submitting Pull Requests # Pull Requests and Contributing to Libxlsxwriter All patches and pull requests are welcome but in general you should start with an issue tracker to describe what you intend to do before you do it. ### Getting Started 1. Pull requests and new feature proposals must start with an [issue tracker][issues]. This serves as the focal point for the design discussion. 2. Describe what you plan to do. If there are API changes add some code example to demonstrate them. 3. Fork the repository. 4. Run all the tests to make sure the current code works on your system using `make test`. See the [Running the Test Suite][tests] section of the docs for instructions. 5. Create a feature branch for your new feature. [tests]: http://libxlsxwriter.github.io/running_the_tests.html ### Code Style The code style is mainly K&R style with 4 space indents. The author uses GNU indent (`gindent`) 2.2.10 with the following options: ``` --braces-on-if-line --braces-on-struct-decl-line --case-indentation 4 --continue-at-parentheses --declaration-comment-column 0 --format-first-column-comments --honour-newlines --ignore-profile --indent-label 0 --indent-level 4 --no-space-after-function-call-names --no-tabs --swallow-optional-blank-lines ``` The [indent configuration file][indentpro] is available in the repo. The code can be indented automatically if the same version of `gindent` is used with the following make command: ```shell make indent ``` Note, make sure you have backed up your files or added them to the index before running this command. In general follow the existing style in the code. [indentpro]: https://github.com/jmcnamara/libxlsxwriter/blob/master/.indent.pro ### Writing and Running Tests Any significant features should be accompanied by a test. See the `test` directory and the [Running the Test Suite][tests] section of the docs for details of the test setup. The tests can be run as follows: ```shell make test ``` Same as: ```shell make test_unit make test_functional ``` The functional tests require the Python module [pytest][pytest] as a test runner. If you have `valgrind` installed you can use the test suite to check for memory leaks: ```shell make test_valgrind ``` When you push your changes they will also be tested automatically using [GitHub Actions][actions]. [actions]: https://github.com/jmcnamara/libxlsxwriter/actions [pytest]: http://pytest.org/ ### Documentation The `libxlsxwriter` documentation is written in Doxygen format in the header files and in additional `.dox` files in the `docs/src` directory of the repo. The documentation can be built as follows: ```shell make docs open docs/html/index.html ``` ### Example programs If applicable add an example program to the `examples` directory. Example files can be built using: ```shell make docs ``` ### Copyright and License Copyright remains with the original author. Do not include additional copyright claims or Licensing requirements. GitHub and the `git` repository will record your contribution and it will be acknowledged it in the Changes file. ### Submitting the Pull Request If your change involves several incremental `git` commits then `rebase` or `squash` them onto another branch so that the Pull Request is a single commit or a small number of logical commits. Push your changes to GitHub and submit the Pull Request with a hash link to the to the Issue tracker that was opened above. libxlsxwriter-RELEASE_1.1.5/.github/workflows/000077500000000000000000000000001435360132600212005ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/.github/workflows/cmake_actions.yml000066400000000000000000000027421435360132600245300ustar00rootroot00000000000000name: Build with CMake on: [push, pull_request] jobs: build: name: Cmake strategy: matrix: cc: [gcc, clang] cmake_flags: ["", "-DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON", "-DUSE_DTOA_LIBRARY=ON -DBUILD_TESTS=ON", "-DUSE_MEM_FILE=ON -DBUILD_TESTS=ON", "-DUSE_NO_MD5=ON -DBUILD_TESTS=ON", "-DUSE_OPENSSL_MD5=ON -DBUILD_TESTS=ON", "-DUSE_STANDARD_TMPFILE=ON -DBUILD_TESTS=ON", "-DUSE_SYSTEM_MINIZIP=ON -DBUILD_TESTS=ON", "-DUSE_SYSTEM_MINIZIP=ON -DUSE_OPENSSL_MD5=ON -DBUILD_TESTS=ON"] runs-on: ubuntu-latest env: CC: ${{ matrix.cc }} steps: - uses: actions/checkout@v2 - name: Install dependencies run: | python -m pip install --upgrade pip pip install pytest sudo apt-get -y install zlib1g-dev sudo apt-get -y install libminizip-dev sudo apt-get -y install libssl-dev - name: Configure CMake working-directory: ${{ github.workspace }}/cmake run: cmake .. -DBUILD_TESTS=ON ${{ matrix.cmake_flags }} -DCMAKE_BUILD_TYPE=Release - name: Build working-directory: ${{ github.workspace }}/cmake run: cmake --build . --config Release --parallel - name: Test working-directory: ${{ github.workspace }}/cmake run: ctest -C Release -V libxlsxwriter-RELEASE_1.1.5/.github/workflows/code_style.yml000066400000000000000000000006341435360132600240600ustar00rootroot00000000000000name: Check code style on: [push, pull_request] jobs: build: name: Check code style runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install dependencies run: | sudo apt-get -y install indent sudo ln -s /usr/bin/indent /usr/bin/gindent - name: Make indent run: | make indent git status | grep 'nothing to commit' libxlsxwriter-RELEASE_1.1.5/.github/workflows/coverity.yml000066400000000000000000000007261435360132600235740ustar00rootroot00000000000000name: Coverity Scan on: push: branches: [coverity] jobs: coverity: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Build third party libs to exclude them from scan run: make third_party - uses: vapier/coverity-scan-action@v1 with: project: libxlsxwriter email: ${{ secrets.COVERITY_SCAN_EMAIL }} token: ${{ secrets.COVERITY_SCAN_TOKEN }} command: make -C src libxlsxwriter.a libxlsxwriter-RELEASE_1.1.5/.github/workflows/make_actions.yml000066400000000000000000000023711435360132600243630ustar00rootroot00000000000000name: Build with Make on: [push, pull_request] jobs: build: name: Make strategy: matrix: cc: [gcc, clang] make_flags: ["", "USE_STANDARD_TMPFILE=1", "USE_SYSTEM_MINIZIP=1", "USE_DTOA_LIBRARY=1", "USE_NO_MD5=1", "USE_OPENSSL_MD5=1", "USE_MEM_FILE=1"] runs-on: ubuntu-latest env: CC: ${{ matrix.cc }} CXX: ${{ matrix.cc }} CFLAGS: '-Werror' steps: - uses: actions/checkout@v2 - name: Install dependencies run: | python -m pip install --upgrade pip pip install pytest sudo apt-get -y install zlib1g-dev sudo apt-get -y install libminizip-dev sudo apt-get -y install libssl-dev sudo apt-get -y install valgrind - name: make run: ${{ matrix.make_flags }} make V=1 - name: test unit run: ${{ matrix.make_flags }} make test_unit V=1 - name: test functional run: ${{ matrix.make_flags }} make test_functional V=1 -j - name: test cpp run: ${{ matrix.make_flags }} make test_cpp V=1 - name: test examples run: ${{ matrix.make_flags }} make examples V=1 libxlsxwriter-RELEASE_1.1.5/.github/workflows/valgrind.yml000066400000000000000000000006021435360132600235270ustar00rootroot00000000000000name: Test for memory leaks on: [push, pull_request] jobs: build: name: Valgrind runs-on: ubuntu-latest env: CC: gcc steps: - uses: actions/checkout@v2 - name: Install dependencies run: | sudo apt-get -y install valgrind sudo apt-get -y install zlib1g-dev - name: test valgrind run: make test_valgrind V=1 -j 2 libxlsxwriter-RELEASE_1.1.5/.github/workflows/windows_build.yml000066400000000000000000000032201435360132600245710ustar00rootroot00000000000000name: Cmake on Windows on: [push, pull_request] jobs: build: name: CMake on Windows strategy: matrix: cmake_flags: ["-DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON", "-DUSE_DTOA_LIBRARY=ON -DBUILD_TESTS=ON", "-DUSE_OPENSSL_MD5=ON -DBUILD_TESTS=ON", "-DUSE_SYSTEM_MINIZIP=ON -DBUILD_TESTS=ON", "-DUSE_SYSTEM_MINIZIP=ON -DUSE_OPENSSL_MD5=ON -DBUILD_TESTS=ON"] runs-on: windows-latest steps: - uses: actions/checkout@v2 - name: Install dependencies working-directory: ${{env.GITHUB_WORKSPACE}} shell: cmd run: | vcpkg.exe install zlib:x64-windows minizip:x64-windows openssl:x64-windows vcpkg.exe integrate install pip install pytest - name: Configure CMake working-directory: ${{env.GITHUB_WORKSPACE}} shell: cmd run: | cd cmake call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat" cmake .. -DCMAKE_BUILD_TYPE=Release ${{ matrix.cmake_flags }} -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -A x64 - name: Build working-directory: ${{env.GITHUB_WORKSPACE}} shell: cmd run: | cd cmake call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat" cmake --build . --config Release - name: Test working-directory: ${{env.GITHUB_WORKSPACE}} shell: cmd run: | cd cmake copy test\functional\src\Release\*.exe test\functional\src pytest -v test/functional libxlsxwriter-RELEASE_1.1.5/.gitignore000066400000000000000000000015021435360132600175710ustar00rootroot00000000000000*.a *.o *.so *.so.* *.to *.lo *.la *.dylib *.dll *.gcno *.gcda test_* !test_*.c !test_*.cpp !test_*.py *.tar.gz *~ TAGS .#* *# ~*xlsx *.xlsx *.bak !test/functional/xlsx_files/*.xlsx *.pyc .pytest_cache/ .cproject .project .pydevproject .settings/ .DS_Store __pycache__ .cache docs/html docs/latex .deps .dirstamp _temp.c examples/* !examples/*.c !examples/*.png !examples/Makefile !examples/vbaProject.bin cov-int libxlsxwriter-coverity.tgz build third_party/zlib-1.2.8/configure.log third_party/zlib-1.2.8/contrib/minizip/miniunz third_party/zlib-1.2.8/contrib/minizip/minizip third_party/zlib-1.2.8/example third_party/zlib-1.2.8/examplesh third_party/zlib-1.2.8/minigzip third_party/zlib-1.2.8/minigzipsh third_party/zlib-1.2.8/zlib.pc cmake !cmake/FindMINIZIP.cmake !cmake/FindPackage.cmake !cmake/i686-toolchain.cmake .vscode libxlsxwriter-RELEASE_1.1.5/.indent.pro000066400000000000000000000061721435360132600176720ustar00rootroot00000000000000/* * Indent rules for libxlsxwriter. * * The rules for user defined typedefs can be update as follows: * perl -i -pe 'print and last if /[l]ibxlsxwriter typedefs/' .indent.pro ack -h typedef include/xlsxwriter/*.h src/*.c | perl -lne 'print "-T $1" if /\w+\s+\w+\s+(\w+)/' | sort >> .indent.pro * */ /* Command line options used with GNU indent 2.2.10 */ --braces-on-if-line --braces-on-struct-decl-line --case-indentation 4 --continue-at-parentheses --declaration-comment-column 0 --format-first-column-comments --honour-newlines --ignore-profile --indent-label 0 --indent-level 4 --no-space-after-function-call-names --no-tabs --swallow-optional-blank-lines /* Typedefs used in the code. */ -T int8_t -T int16_t -T int32_t -T int64_t -T uint8_t -T uint16_t -T uint32_t -T uint64_t -T ssize_t -T size_t -T time_t -T LIST_ENTRY -T RB_ENTRY -T SLIST_ENTRY -T STAILQ_ENTRY -T TAILQ_ENTRY /* libxlsxwriter typedefs. */ -T lxw_app -T lxw_author_id -T lxw_autofilter -T lxw_border -T lxw_button_options -T lxw_cell -T lxw_chart -T lxw_chart_axis -T lxw_chart_axis_display_unit -T lxw_chart_axis_label_alignment -T lxw_chart_axis_label_position -T lxw_chart_axis_tick_mark -T lxw_chart_axis_tick_position -T lxw_chart_axis_type -T lxw_chart_blank -T lxw_chart_custom_label -T lxw_chart_data_label -T lxw_chart_error_bar_axis -T lxw_chart_error_bar_cap -T lxw_chart_error_bar_direction -T lxw_chart_error_bar_type -T lxw_chart_fill -T lxw_chart_font -T lxw_chart_gridline -T lxw_chart_label_position -T lxw_chart_label_separator -T lxw_chart_legend -T lxw_chart_legend_position -T lxw_chart_line -T lxw_chart_line_dash_type -T lxw_chart_marker -T lxw_chart_marker_type -T lxw_chart_options -T lxw_chart_pattern -T lxw_chart_pattern_type -T lxw_chart_point -T lxw_chart_series -T lxw_chart_title -T lxw_chart_trendline_type -T lxw_chart_type -T lxw_chartsheet -T lxw_chartsheet_name -T lxw_col_options -T lxw_col_t -T lxw_color_t -T lxw_comment -T lxw_comment_options -T lxw_cond_format_hash_element -T lxw_cond_format_obj -T lxw_conditional_format -T lxw_content_types -T lxw_core -T lxw_custom -T lxw_custom_property -T lxw_data_val_obj -T lxw_data_validation -T lxw_datetime -T lxw_defined_name -T lxw_doc_properties -T lxw_drawing -T lxw_drawing_coords -T lxw_drawing_object -T lxw_drawing_rel_id -T lxw_error -T lxw_fill -T lxw_filter_rule -T lxw_filter_rule_obj -T lxw_font -T lxw_format -T lxw_hash_element -T lxw_hash_table -T lxw_header_footer_options -T lxw_heading_pair -T lxw_image_md5 -T lxw_image_options -T lxw_merged_range -T lxw_metadata -T lxw_object_properties -T lxw_packager -T lxw_panes -T lxw_part_name -T lxw_print_area -T lxw_protection -T lxw_protection_obj -T lxw_rel_tuple -T lxw_relationships -T lxw_repeat_cols -T lxw_repeat_rows -T lxw_rich_string_tuple -T lxw_row -T lxw_row_col_options -T lxw_row_t -T lxw_selection -T lxw_series_data_point -T lxw_series_error_bars -T lxw_series_range -T lxw_sheet -T lxw_sst -T lxw_styles -T lxw_table -T lxw_table_column -T lxw_table_obj -T lxw_table_options -T lxw_theme -T lxw_tuple -T lxw_vml -T lxw_vml_obj -T lxw_workbook -T lxw_workbook_options -T lxw_worksheet -T lxw_worksheet_init_data -T lxw_worksheet_name libxlsxwriter-RELEASE_1.1.5/CMakeLists.txt000066400000000000000000000347601435360132600203550ustar00rootroot00000000000000# :copyright: (c) 2017 Alex Huszagh. # :license: FreeBSD, see LICENSE.txt for more details. # Description # =========== # # Use: # Move to a custom directory, ideally out of source, and # type `cmake $LXW_SOURCE $FLAGS`, where `LXW_SOURCE` is the # path to the libxlsxwriter project, and `FLAGS` are custom # flags to pass to the compiler. # # Example: # For example, in the project directory, to build libxlsxwriter # and the unittests in release mode, type: # mkdir build && cd build # cmake .. -DBUILD_TESTS=ON -DCMAKE_BUILD_TYPE=Release # cmake --build . --config Release # ctest -C Release -V # cmake --build . --config Release --target install # # If using a Makefile generator, you may use the simpler # mkdir build && cd build # cmake .. -DBUILD_TESTS=ON -DCMAKE_BUILD_TYPE=Release # make # make test # make install # # Flags: # ZLIB_ROOT # The ZLIB root directory can be specified either through # an environment variable (`export ZLIB_ROOT=/usr/include`) # or using a flag with CMake (`-DZLIB_ROOT:STRING=/usr/include`). # This sets the preferred search path for the ZLIB installation. # # BUILD_TESTS # Build unittests (default off). To build the unittests, # pass `-DBUILD_TESTS=ON` during configuration. # # BUILD_EXAMPLES # Build example files (default off). To build the examples, # pass `-DBUILD_EXAMPLES=ON` during configuration. # # USE_STANDARD_TMPFILE # Use the standard tmpfile() function (default off). To enable # the standard tmpfile, pass `-DUSE_STANDARD_TMPFILE=ON` # during configuration. This may produce bugs while cross- # compiling or using MinGW/MSYS. # # USE_DTOA_LIBRARY # Use the third party emyg_dtoa() library (default off). The # emyg_dtoa() library is used to avoid sprintf double issues with # different locale settings. To enable this library, pass # `-DUSE_DTOA_LIBRARY=ON` during configuration. # # USE_NO_MD5 # Compile without third party MD5 support. This will turn off the # functionality of avoiding duplicate image files in the output xlsx # file. To enable this option pass `-DUSE_NO_MD5=ON` during # configuration. # # USE_OPENSSL_MD5 Compile with OpenSSL MD5 support. This will link # against libcrypto for MD5 support rather than using the local MD5 # support. MD5 support is required to avoid duplicate image files in # the output xlsx file. To enable this option pass # `-DUSE_OPENSSL_MD5=ON` during configuration. # # USE_STATIC_MSVC_RUNTIME # Use the static msvc runtime library when compiling with msvc (default off) # To enable, pass `-DUSE_STATIC_MSVC_RUNTIME` during configuration. # # Toolchains: # On multiarch Linux systems, which can build and run multiple # binary targets on the same system, we include an `i686-toolchain` # file to enable building i686 (x86 32-bit) targets on x86_64 systems. # To use the i686 toolchain, pass the `-DCMAKE_TOOLCHAIN_FILE` option # during CMake configuration. For example, from the build directory, # you would use: # cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/i686-toolchain.cmake # # CMake Options: # CMake sets debug and release builds with the `CMAKE_BUILD_TYPE` # option, which can be set as a flag during configuration. # To build in release mode, pass `-DCMAKE_BUILD_TYPE=Release` # during configuration. # # CMake sets the creation of static and shared libraries with the # `BUILD_SHARED_LIBS` option, which can be set as a flag during # configuration. To build a static library, pass # `-DBUILD_SHARED_LIBS=OFF` during configuration. # # Generators: # CMake also supports custom build generators, such as MakeFiles, # Ninja, Visual Studio, and XCode. For example, to generate # a Visual Studio solution, configure with: # cmake .. -G "Visual Studio 14 2015 Win64" # # For more information on using generators, see: # https://cmake.org/cmake/help/v3.0/manual/cmake-generators.7.html # set(CMAKE_LEGACY_CYGWIN_WIN32 1) if(MSVC) cmake_minimum_required(VERSION 3.4) else() cmake_minimum_required(VERSION 3.1) endif() SET(XLSX_PROJECT_NAME "xlsxwriter" CACHE STRING "Optional project and binary name") set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON) project(${XLSX_PROJECT_NAME} C) enable_testing() # POLICY # ------ # The use of the word ZLIB_ROOT should still work prior to "3.12.0", # just it's been generalized for all packages now. Just set the policy # to new, so we use it, and it will be used prior to 3.12 anyway. if(${CMAKE_VERSION} VERSION_GREATER "3.12" OR ${CMAKE_VERSION} VERSION_EQUAL "3.12") cmake_policy(SET CMP0074 NEW) endif() # OPTIONS # ------- SET(ZLIB_ROOT "" CACHE STRING "Optional root for the ZLIB installation") option(BUILD_TESTS "Build libxlsxwriter tests" OFF) option(BUILD_EXAMPLES "Build libxlsxwriter examples" OFF) option(USE_SYSTEM_MINIZIP "Use system minizip installation" OFF) option(USE_STANDARD_TMPFILE "Use the C standard library's tmpfile()" OFF) option(USE_NO_MD5 "Build libxlsxwriter without third party MD5 lib" OFF) option(USE_OPENSSL_MD5 "Build libxlsxwriter with the OpenSSL MD5 lib" OFF) option(USE_MEM_FILE "Use fmemopen()/open_memstream() in place of temporary files" OFF) option(IOAPI_NO_64 "Disable 64-bit filesystem support" OFF) option(USE_DTOA_LIBRARY "Use the locale independent third party Milo Yip DTOA library" OFF) if(MSVC) option(USE_STATIC_MSVC_RUNTIME "Use the static runtime library" OFF) endif() if(DEFINED ENV{${ZLIB_ROOT}}) set(ZLIB_ROOT $ENV{ZLIB_ROOT}) endif() if(IOAPI_NO_64) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS IOAPI_NO_64=1) endif() # CONFIGURATIONS # -------------- if(USE_SYSTEM_MINIZIP) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_SYSTEM_MINIZIP) endif() if(USE_STANDARD_TMPFILE) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_STANDARD_TMPFILE) endif() if(NOT USE_OPENSSL_MD5 AND USE_NO_MD5) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_NO_MD5) endif() if(USE_OPENSSL_MD5) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_OPENSSL_MD5) if(NOT MSVC) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-deprecated-declarations") endif() endif() if(USE_MEM_FILE OR USE_FMEMOPEN) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_FMEMOPEN) endif() if(USE_DTOA_LIBRARY) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_DTOA_LIBRARY) endif() if(NOT BUILD_SHARED_LIBS) if(UNIX) set(CMAKE_POSITION_INDEPENDENT_CODE ON) elseif(MINGW OR MSYS) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -static -static-libgcc -Wno-char-subscripts -Wno-long-long") list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS USE_FILE32API) elseif(MSVC) set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /Fd\"${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pdb\"") set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Ox /Zi /Fd\"${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pdb\"") set(CMAKE_C_FLAGS_MINSIZEREL "${CMAKE_C_FLAGS_MINSIZEREL} /Zi /Fd\"${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pdb\"") set(CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_FLAGS_RELWITHDEBINFO} /Fd\"${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pdb\"") endif() endif() if(MSVC AND USE_STATIC_MSVC_RUNTIME) foreach(flag_var CMAKE_C_FLAGS CMAKE_C_FLAGS_DEBUG CMAKE_C_FLAGS_RELEASE CMAKE_C_FLAGS_MINSIZEREL CMAKE_C_FLAGS_RELWITHDEBINFO) if(${flag_var} MATCHES "/MD") string(REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}") endif() endforeach() endif() # Configure pkg-config file(READ "include/xlsxwriter.h" ver) string(REGEX MATCH "LXW_VERSION \"([^\"]+)\"" _ ${ver}) set(VERSION ${CMAKE_MATCH_1}) string(REGEX MATCH "LXW_SOVERSION \"([^\"]+)\"" _ ${ver}) set(SOVERSION ${CMAKE_MATCH_1}) set(PREFIX ${CMAKE_INSTALL_PREFIX}) configure_file(dev/release/pkg-config.txt xlsxwriter.pc @ONLY) # INCLUDES # -------- enable_language(CXX) list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # ZLIB find_package(ZLIB REQUIRED "1.0") list(APPEND LXW_PRIVATE_INCLUDE_DIRS ${ZLIB_INCLUDE_DIRS}) message("zlib version: " ${ZLIB_VERSION}) # MINIZIP if (USE_SYSTEM_MINIZIP) find_package(MINIZIP REQUIRED "1.0") list(APPEND LXW_PRIVATE_INCLUDE_DIRS ${MINIZIP_INCLUDE_DIRS}) endif() # LIBRARY # ------- list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS NOCRYPT NOUNCRYPT) # Ensure CRT Secure warnings are disabled if(MSVC) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS _CRT_SECURE_NO_WARNINGS) endif() # Ensure "TESTING" macro is defined if building tests if(BUILD_TESTS) list(APPEND LXW_PRIVATE_COMPILE_DEFINITIONS TESTING) endif() file(GLOB LXW_SOURCES src/*.c) file(GLOB_RECURSE LXW_HEADERS RELATIVE include *.h) if(NOT USE_SYSTEM_MINIZIP) list(APPEND LXW_SOURCES third_party/minizip/ioapi.c third_party/minizip/zip.c) if(MSVC) list(APPEND LXW_SOURCES third_party/minizip/iowin32.c) endif() endif() if (NOT USE_STANDARD_TMPFILE) list(APPEND LXW_SOURCES third_party/tmpfileplus/tmpfileplus.c) endif() if(NOT USE_OPENSSL_MD5 AND NOT USE_NO_MD5) list(APPEND LXW_SOURCES third_party/md5/md5.c) endif() if(USE_OPENSSL_MD5) find_package(OpenSSL REQUIRED) if(OpenSSL_FOUND) include_directories(${OPENSSL_INCLUDE_DIR}) message(STATUS "OpenSSL version: ${OPENSSL_VERSION}") endif() endif() if (USE_DTOA_LIBRARY) list(APPEND LXW_SOURCES third_party/dtoa/emyg_dtoa.c) endif() set(LXW_PROJECT_DIR "${CMAKE_CURRENT_SOURCE_DIR}") set(LXW_LIB_DIR "${LXW_PROJECT_DIR}/lib") add_library(${PROJECT_NAME} "") set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${SOVERSION}) target_sources(${PROJECT_NAME} PRIVATE ${LXW_SOURCES} PUBLIC ${LXW_HEADERS} ) target_link_libraries(${PROJECT_NAME} LINK_PUBLIC ${ZLIB_LIBRARIES} ${MINIZIP_LIBRARIES} ${LIB_CRYPTO} ${OPENSSL_CRYPTO_LIBRARY}) target_compile_definitions(${PROJECT_NAME} PRIVATE ${LXW_PRIVATE_COMPILE_DEFINITIONS}) # /utf-8 needs VS2015 Update 2 or above. # In CMake 3.7 and above, we can use (MSVC_VERSION GREATER_EQUAL 1900) here. if(MSVC AND NOT (MSVC_VERSION LESS 1900)) target_compile_options(${PROJECT_NAME} PRIVATE /utf-8) endif() if (WINDOWSSTORE) target_compile_definitions(${PROJECT_NAME} PRIVATE -DIOWIN32_USING_WINRT_API) endif() target_include_directories(${PROJECT_NAME} PRIVATE ${LXW_PRIVATE_INCLUDE_DIRS} PUBLIC include include/xlsxwriter ) # TESTS # ----- # Create test and runner. # # Args: # sources Name of variable holding source files # target Test name # macro(CreateTest sources target) set(output_name xlsxwriter_${target}) set(dependencies ${output_name}) add_executable(${output_name} ${${sources}}) target_link_libraries(${output_name} ${PROJECT_NAME}) target_compile_definitions(${output_name} PRIVATE TESTING COLOR_OK) add_test(NAME ${output_name} COMMAND ${output_name} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} ) endmacro(CreateTest) file(GLOB LXW_UTILITY_SOURCES test/unit/utility/test*.c) file(GLOB LXW_XMLWRITER_SOURCES test/unit/xmlwriter/test*.c) file(GLOB LXW_WORKSHEET_SOURCES test/unit/worksheet/test*.c) file(GLOB LXW_SST_SOURCES test/unit/sst/test*.c) file(GLOB LXW_WORKBOOK_SOURCES test/unit/workbook/test*.c) file(GLOB LXW_APP_SOURCES test/unit/app/test*.c) file(GLOB LXW_CONTENTTYPES_SOURCES test/unit/content_types/test*.c) file(GLOB LXW_CORE_SOURCES test/unit/core/test*.c) file(GLOB LXW_RELATIONSHIPS_SOURCES test/unit/relationships/test*.c) file(GLOB LXW_FORMAT_SOURCES test/unit/format/test*.c) file(GLOB LXW_STYLES_SOURCES test/unit/styles/test*.c) file(GLOB LXW_DRAWING_SOURCES test/unit/drawing/test*.c) file(GLOB LXW_CHART_SOURCES test/unit/chart/test*.c) file(GLOB LXW_CUSTOM_SOURCES test/unit/custom/test*.c) file(GLOB LXW_FUNCTIONAL_SOURCES test/functional/src/*.c) set(LXW_UNIT_SOURCES test/unit/test_all.c ${LXW_UTILITY_SOURCES} ${LXW_XMLWRITER_SOURCES} ${LXW_WORKSHEET_SOURCES} ${LXW_SST_SOURCES} ${LXW_WORKBOOK_SOURCES} ${LXW_APP_SOURCES} ${LXW_CONTENTTYPES_SOURCES} ${LXW_CORE_SOURCES} ${LXW_RELATIONSHIPS_SOURCES} ${LXW_FORMAT_SOURCES} ${LXW_STYLES_SOURCES} ${LXW_DRAWING_SOURCES} ${LXW_CHART_SOURCES} ${LXW_CUSTOM_SOURCES} ) if(BUILD_TESTS) # unit tests CreateTest(LXW_UNIT_SOURCES unit) # functional tests find_package(Python COMPONENTS Interpreter REQUIRED) find_program(Pytest_EXECUTABLE NAMES pytest) if (NOT Pytest_EXECUTABLE) message("Please install the Python pytest library to run functional tests:") message(" pip install pytest\n") endif() foreach(source ${LXW_FUNCTIONAL_SOURCES}) get_filename_component(basename ${source} NAME_WE) add_executable(${basename} ${source}) target_link_libraries(${basename} xlsxwriter) set_target_properties(${basename} PROPERTIES RUNTIME_OUTPUT_DIRECTORY "test/functional/src") endforeach(source) add_custom_command(TARGET xlsxwriter_unit POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/test/functional test/functional ) if(USE_NO_MD5) add_test(NAME functional COMMAND pytest -v test/functional -m "not skipif" WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} ) else() add_test(NAME functional COMMAND pytest -v test/functional WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} ) endif() endif() # EXAMPLES # -------- file(GLOB LXW_EXAMPLE_SOURCES examples/*.c) if(BUILD_EXAMPLES) foreach(source ${LXW_EXAMPLE_SOURCES}) get_filename_component(basename ${source} NAME_WE) add_executable(${basename} ${source}) target_link_libraries(${basename} ${PROJECT_NAME}) set_target_properties(${basename} PROPERTIES RUNTIME_OUTPUT_DIRECTORY "examples") endforeach(source) endif() # INSTALL # ------- include(GNUInstallDirs) install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ) install(FILES include/xlsxwriter.h DESTINATION include) install(DIRECTORY include/xlsxwriter DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} FILES_MATCHING PATTERN "*.h" ) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/xlsxwriter.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) libxlsxwriter-RELEASE_1.1.5/CONTRIBUTING.md000066400000000000000000000136171435360132600200440ustar00rootroot00000000000000# libxlsxwriter: Reporting Bugs and submitting Pull Requests ## Reporting Bugs Here are some tips on reporting bugs in `libxlsxwriter`. ### Upgrade to the latest version of the library Upgrade to the latest version of the library since the bug you are reporting may already be fixed. Check the [Changes][changes] section of the documentation to see what has changed in the latest versions. [changes]: http://libxlsxwriter.github.io/changes.html You can check which version of `libxlsxwriter` that you are using by checking the `xlsxwriter.h` header file or by adding the following to your program: ```C #include #include "xlsxwriter.h" int main() { printf("Libxlsxwriter version = %s\n", lxw_version()); return 0; } ``` ### Read the documentation Read or search the `libxlsxwriter` [documentation][docs] to see if the issue you are encountering is already explained. [docs]: http://libxlsxwriter.github.io/index.html ### Look at the example programs There are many [examples programs][examples] in the distribution. Try to identify an example program that corresponds to your query and adapt it to use as a bug report. [examples]: http://libxlsxwriter.github.io/examples.html ### Use the xlsxwriter Issue Tracker The [libxlsxwriter issue tracker][issues] is on GitHub. [issues]: https://github.com/jmcnamara/libxlsxwriter/issues ### Tips for submitting a bug report 1. Describe the problem as clearly and as concisely as possible. 2. Include a sample program. This is probably the most important step. It is generally easier to describe a problem in code than in written prose. 3. The sample program should be as small as possible to demonstrate the problem. Don't copy and paste large non-relevant sections of your program. A sample bug report is shown below. This format helps analyze and respond to the bug report more quickly. > Subject: Issue with SOMETHING > > Greetings, > > I am using libxlsxwriter to do SOMETHING but it appears to do SOMETHING ELSE. > > I am using CC version X.Y.Z, OS = uname and libxlsxwriter x.y.z. > > Here is some code that demonstrates the problem: > > >```C >#include "xlsxwriter.h" > >int main() { > > lxw_workbook *workbook = workbook_new("bug_report.xlsx"); > lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL); > > worksheet_write_string(worksheet, 0, 0, "Hello", NULL); > worksheet_write_number(worksheet, 1, 0, 123, NULL); > > return workbook_close(workbook); >} >``` > # Pull Requests and Contributing to Libxlsxwriter All patches and pull requests are welcome but in general you should start with an issue tracker to describe what you intend to do before you do it. ### Getting Started 1. Pull requests and new feature proposals must start with an [issue tracker][issues]. This serves as the focal point for the design discussion. 2. Describe what you plan to do. If there are API changes add some code example to demonstrate them. 3. Fork the repository. 4. Run all the tests to make sure the current code works on your system using `make test`. See the [Running the Test Suite][tests] section of the docs for instructions. 5. Create a feature branch for your new feature. [tests]: http://libxlsxwriter.github.io/running_the_tests.html ### Code Style The code style is mainly K&R style with 4 space indents. The author uses GNU indent (`gindent`) 2.2.10 with the following options: ``` --braces-on-if-line --braces-on-struct-decl-line --case-indentation 4 --continue-at-parentheses --declaration-comment-column 0 --format-first-column-comments --honour-newlines --ignore-profile --indent-label 0 --indent-level 4 --no-space-after-function-call-names --no-tabs --swallow-optional-blank-lines ``` The [indent configuration file][indentpro] is available in the repo. The code can be indented automatically if the same version of `gindent` is used with the following make command: ```shell make indent ``` Note, make sure you have backed up your files or added them to the index before running this command. In general follow the existing style in the code. [indentpro]: https://github.com/jmcnamara/libxlsxwriter/blob/master/.indent.pro ### Writing and Running Tests Any significant features should be accompanied by a test. See the `test` directory and the [Running the Test Suite][tests] section of the docs for details of the test setup. The tests can be run as follows: ```shell make test ``` Same as: ```shell make test_unit make test_functional ``` The functional tests require the Python module [pytest][pytest] as a test runner. If you have `valgrind` installed you can use the test suite to check for memory leaks: ```shell make test_valgrind ``` When you push your changes they will also be tested automatically using [GitHub Actions][actions]. [actions]: https://github.com/jmcnamara/libxlsxwriter/actions [pytest]: http://pytest.org/ ### Documentation The `libxlsxwriter` documentation is written in Doxygen format in the header files and in additional `.dox` files in the `docs/src` directory of the repo. The documentation can be built as follows: ```shell make docs open docs/html/index.html ``` ### Example programs If applicable add an example program to the `examples` directory. Example files can be built using: ```shell make docs ``` ### Copyright and License Copyright remains with the original author. Do not include additional copyright claims or Licensing requirements. GitHub and the `git` repository will record your contribution and it will be acknowledged it in the Changes file. ### Submitting the Pull Request If your change involves several incremental `git` commits then `rebase` or `squash` them onto another branch so that the Pull Request is a single commit or a small number of logical commits. Push your changes to GitHub and submit the Pull Request with a hash link to the to the Issue tracker that was opened above. libxlsxwriter-RELEASE_1.1.5/Changes.txt000066400000000000000000000713421435360132600177230ustar00rootroot00000000000000/** @page changes Changes ## 1.1.5 December 30 2022 - Added support for writing a workbook to a memory buffer instead of to a file via the `output_buffer` parameter of @ref workbook_new_opt(). See also @ref output_buffer.c. - Add support for using in-memory data instead of temporary files on systems where `fmemopen()` and `open_memstream()` are supported. This requires the `USE_MEM_FILE` compilation option. ## 1.1.4 October 9 2021 - Added support for Worksheet tables. Tables in Excel are a way of grouping a range of cells into a single entity that has common formatting or that can be referenced from formulas. Tables can have column headers, autofilters, total rows, column formulas and default formatting. See @ref working_with_tables and @ref tables.c. - Added support for adding a macro button to a worksheet. See @ref macro.c. ## 1.1.3 August 9 2021 - Changed worksheet_filter_column2() parameter name "operator" to "and_or" to avoid a conflict with the C++ reserved keyword. ## 1.1.2 August 8 2021 - Added support for autofilter rules. See @ref working_with_autofilters and @ref autofilter.c. Feature request [#254][gh_254]. [gh_254]: https://github.com/jmcnamara/libxlsxwriter/issues/254 - Added Description/Alt Text and Decorative accessibility options for charts. These options were already available for images. ## 1.1.1 July 12 2021 - Added optional third party library to handle sprintf handling of doubles. This is to avoid issues with number formatting in some locales. The optional library is the Milo Yip DTOA implementation. See @ref gsg_dtoa. Issue [#272][gh_272]. [gh_272]: https://github.com/jmcnamara/libxlsxwriter/issues/272 - Added the #LXW_EXPLICIT_FALSE variable to allow the default bold property in chart title fonts to be turned off. Issue [#199][gh_199]. [gh_199]: https://github.com/jmcnamara/libxlsxwriter/issues/199 ## 1.1.0 July 9 2021 - Fix for Cocoapod issue where local md5 files conflicted with BoringSSL headers. Issue [#342][gh_342]. [gh_342]: https://github.com/jmcnamara/libxlsxwriter/issues/342 ## 1.0.9 July 7 2021 - Added support for Excel 365 dynamic arrays. See `worksheet_write_dynamic_array_formula()` `worksheet_write_dynamic_formula()` and @ref ww_formulas_dynamic_arrays. ## 1.0.8 July 3 2021 - Fix for dynamic library soname on Linux. ## 1.0.7 July 1 2021 - Added support for writing Unix date/times via the `worksheet_write_unixtime()` function. - Added support for dynamic library soname version to help packagers and build systems differentiate ABI versions. ## 1.0.6 May 28 2021 - Added support for using OpenSSL MD5 functions instead of built in third party library. See @ref gsg_md5. ## 1.0.5 May 13 2021 - Added support for worksheet background images via `worksheet_set_background()`. ## 1.0.4 May 8 2021 - Added support for GIF image files (and in Excel 365, animated GIF files). ## 1.0.3 April 20 2021 - Added some fixes to make the library compile more cleanly as an R library. ## 1.0.2 April 15 2021 - Added option to set row heights and column widths in pixels via the `worksheet_set_row_pixels()` and `worksheet_set_column_pixels()` functions. ## 1.0.1 March 30 2021 - Added support for [pkg-config][pkg-config] to Make/Cmake installs. See the @ref gsg_using section of the Getting Started guide.

[pkg-config]: https://www.freedesktop.org/wiki/Software/pkg-config/ - Added ability to add accessibility options "description" and "decorative" to images via `worksheet_insert_image_opt()` and #lxw_image_options.

- Added the `workbook_read_only_recommended()` function to set the Excel "Read-only Recommended" option that is available when saving a file.

- Fixed issue where pattern formats without colors were given a default black fill color.

- Added option to set a chart crossing to 'min' via `chart_axis_set_crossing_min()` as well as the existing 'max' option. The 'min' option isn't available in the Excel interface but can be enabled via VBA.

- Added some additional information on using constant_memory mode with memory mounted /tmp directories. See @ref ww_mem_temp. Issue [#306][gh_306]. [gh_306]: https://github.com/jmcnamara/libxlsxwriter/issues/306 - Added build option to compile libxlsxwriter as a "universal binary" for both Apple silicon and Intel-based Macs, i.e., arm64 and x86_64. See @ref gsg_universal.

- Fixed issue where the limit for header/footer strings was 255 bytes instead of 255 characters and as a result UTF8 strings were being truncated. Issue [#305][gh_305]. [gh_305]: https://github.com/jmcnamara/libxlsxwriter/issues/305 ## 1.0.0 September 7 2020 - Added support for worksheet conditional formatting. See `worksheet_conditional_format_range()` and @ref working_with_conditional_formatting. Feature request [#32][gh_32] and [#302][gh_302]. [gh_302]: https://github.com/jmcnamara/libxlsxwriter/issues/302 [gh_32]: https://github.com/jmcnamara/libxlsxwriter/issues/32 - Added performance optimization for search for control characters in strings in `worksheet_write_string()`. Issue [#298][gh_298]. [gh_298]: https://github.com/jmcnamara/libxlsxwriter/issues/298 - Made `lxw_datetime_to_excel_datetime()` a function public.

- There are now over 1000 test cases, including 650 tests that compare the output from libxlsxwriter, byte for byte, against test files created in Excel. This is also the 100th release of libxlsxwriter. ## 0.9.9 August 17 2020 - Added support for images in headers and footers. See `worksheet_set_header_opt()`. - Added `worksheet_ignore_errors()` function to ignore Excel worksheet errors/warnings in user defined ranges. ## 0.9.8 August 11 2020 - Added formatting for chart data labels and chart custom data labels. See @ref chart_custom_labels and @ref chart_data_labels.c. ## 0.9.7 August 4 2020 - Changed #lxw_chart_data_label field from `.delete` to `.hide` in order to avoid reserved word conflict with C++. Issue [#300][gh_300]. [gh_300]: https://github.com/jmcnamara/libxlsxwriter/issues/300 ## 0.9.6 August 3 2020 - Added support for chart custom data labels. See @ref chart_custom_labels and @ref chart_data_labels.c. - Fix for issue where array formulas weren't included in the output file for certain ranges/conditions. Issue [#735][gh_735]. [gh_735]: https://github.com/jmcnamara/XlsxWriter/issues/735 ## 0.9.5 May 31 2020 - Fix for issue where hyperlinks urls and tips were ignored for `worksheet_insert_image_buffer_opt()` images. Issue [#292][gh_292]. [gh_292]: https://github.com/jmcnamara/libxlsxwriter/issues/292 - Added #LXW_CHART_LINE_STACKED and #LXW_CHART_LINE_STACKED_PERCENT line charts subtypes. - Removed LXW_ERROR_SHEETNAME_RESERVED warning which was used with the reserved worksheet name "History". However, this is an allowed worksheet name in some Excel variants so the warning has been turned into a documentation note instead. ## 0.9.4 January 19 2020 - Added option to specify worksheet "object positioning" for images and charts to define how they move or size with underlying cells. See @ref ww_object_position_options and @ref working_with_object_positioning. ## 0.9.3 January 13 2020 - Fix Xcode/Cocoapods build warnings. ## 0.9.2 January 13 2020 - Added support for writing cell comments, see @ref working_with_comments. - Makefile now respects DESTDIR and PREFIX, including when setting rpath on macOS. - Changed function names in bundled MD5 code to avoid conflicts with OpenSSL. ## 0.9.1 December 26 2019 - Fix to missing MD5 linkage in Cocoapod file. Issue [#259][gh_259]. [gh_259]: https://github.com/jmcnamara/libxlsxwriter/issues/259 ## 0.9.0 December 26 2019 - Fix to avoid duplicate images being copied to an libxlsxwriter file. Excel uses an optimization where it only stores one copy of a repeated/duplicate image in a workbook. Libxlsxwriter didn't do this which meant that the file size would increase when then was a large number of repeated images. This release fixes that issue and replicates Excel's behavior. Note, that this change adds a dependency on the [Openwall MD5] library, which is now included with the libxlsxwriter third party source files. It is possible to compile libxlsxwriter without this library, and thus getting the older behavior, by passing `USE_NO_MD5=1` to make. [Openwall MD5]: https://openwall.info/wiki/people/solar/software/public-domain-source-code/md5 ## 0.8.9 December 16 2019 - Added support for default hyperlink style in `worksheet_write_url()`. - Added support for hyperlink in images, see `worksheet_insert_image_opt()`. - Fixed several `worksheet_write_url()` edge cases. ## 0.8.8 November 17 2019 - Added option to allow a user defined, or overridden, image description used with `worksheet_insert_image()`. By default it uses the filename as the description. Issue [#238][gh_238]. [gh_238]: https://github.com/jmcnamara/libxlsxwriter/issues/238 - Added Windows portable version of `fopen` to handle utf8 filenames when working with images. Issue [#238][gh_238]. [gh_238]: https://github.com/jmcnamara/libxlsxwriter/issues/238 - Added an option to allow chart fonts to be rotation to 270 deg to give a stacked orientation. Also added support for East Asian vertical chart fonts. - Refactored struct types used in pubic APIs to remove or document hidden fields. @b Note: This change introduces backward incompatible API changes. However, it should minimize any future changes of this nature. See issue [#252][gh_252]. [gh_252]: https://github.com/jmcnamara/libxlsxwriter/issues/252 ## 0.8.7 June 20 2019 - Added support for adding VBA macros to workbooks. These macros can be extracted from existing xlsm files, created in Excel, and added to new xlsm files. See @ref working_with_macros. Feature request [#29][gh_29]. [gh_29]: https://github.com/jmcnamara/libxlsxwriter/issues/29 - Added support for ZIP64 extensions when writing very large xlsx files to allow the zip container, or individual XML files within it, to be greater than 4 GB. See @ref workbook_new_opt(). Feature request [#228][gh_228]. [gh_228]: https://github.com/jmcnamara/libxlsxwriter/issues/228 - Added extra validity checks on worksheet names. Issues [#223][gh_223] and [#230][gh_230]. [gh_223]: https://github.com/jmcnamara/libxlsxwriter/issues/223 [gh_230]: https://github.com/jmcnamara/libxlsxwriter/issues/230 ## 0.8.6 April 7 2019 - Fixed issue where images that started in hidden rows/columns weren't placed correctly in the worksheet. - Fixed the mime-type reported by system `file(1)`. The mime-type reported by "file --mime-type"/magic was incorrect for XlsxWriter files since it expected the `[Content_types]` to be the first file in the zip container. ## 0.8.5 February 10 2019 - Fix compile-time warnings with strict prototypes enabled. Issue [#208][gh_208]. [gh_208]: https://github.com/jmcnamara/libxlsxwriter/issues/208 - Make py.test name configurable. Pull request [#206][gh_206]. [gh_206]: https://github.com/jmcnamara/libxlsxwriter/pull/206 ## 0.8.4 November 10 2018 - Fix for issue when hashing number formats. Issue [#203][gh_203]. [gh_203]: https://github.com/jmcnamara/libxlsxwriter/issues/203 ## 0.8.3 October 1 2018 - Added `worksheet_write_rich_string()` function to allow writing of multi-format rich strings. See @ref rich_strings.c Feature request [#37][gh_37]. [gh_37]: https://github.com/jmcnamara/libxlsxwriter/issues/37 ## 0.8.2 September 16 2018 - Added new chartsheet functionality: `chartsheet_set_tab_color()`, and `chartsheet_set_zoom()`. ## 0.8.1 September 15 2018 - Fix for chartsheet and worksheet ordering issue. - Added new chartsheet functionality: `chartsheet_protect()`, `chartsheet_hide()`, `chartsheet_select()` and `chartsheet_set_first_sheet()`. ## 0.8.0 September 12 2018 - Added chartsheet support. A chartsheet is a type of worksheet that only contains a chart. See the @ref chartsheet.h "Chartsheet" object and @ref chartsheet.c. ## 0.7.9 September 1 2018 - Added `chart_axis_set_label_align()` function to set the alignment of chart category axis labels. Feature request [#186][gh_186]. [gh_186]: https://github.com/jmcnamara/libxlsxwriter/issues/186 - Added `lxw_version()` function to get the library version. Feature request [#194][gh_194]. [gh_194]: https://github.com/jmcnamara/libxlsxwriter/pull/194 ## 0.7.8 August 30 2018 - Added `worksheet_insert_image_buffer()` function to insert images from memory buffers. See @ref image_buffer.c. Feature request [#125][gh_125]. [gh_125]: https://github.com/jmcnamara/libxlsxwriter/issues/125 ## 0.7.7 May 16 2018 - Fix to ensure the use of wide filenames on Windows with Microsoft Visual C++. Issue [#153][gh_153]. [gh_153]: https://github.com/jmcnamara/libxlsxwriter/issues/153 - Added docs on building an app with Cmake and Microsoft Visual C++ on Windows. ## 0.7.6 January 11 2018 - Added support for worksheet Grouping and Outlines. See @ref working_with_outlines. Feature request [#30][gh_30]. [gh_30]: https://github.com/jmcnamara/libxlsxwriter/issues/30 - Fix include of libxlsxwriter as a Cocoapod on macOS. Issue [#94][gh_94]. [gh_94]: https://github.com/jmcnamara/libxlsxwriter/issues/94 ## 0.7.5 September 25 2017 - Added support for data validations and dropdown lists. See @ref working_with_data_validation and @ref data_validate.c. Feature request [#31][gh_31]. [gh_31]: https://github.com/jmcnamara/libxlsxwriter/issues/31 ## 0.7.4 August 20 2017 - Fix make build system "install" target for compatibility with macOS [brew/homebrew](https://brew.sh) installer. See @ref gsg_brew. ## 0.7.3 August 12 2017 - Build system fixes for Gentoo. Issue [#116][gh_116]. [gh_116]: https://github.com/jmcnamara/libxlsxwriter/issues/116 ## 0.7.2 July 26 2017 - Changed font sizes from integer to double to allow fractional font sizes. Issue [#114][gh_114]. [gh_114]: https://github.com/jmcnamara/libxlsxwriter/issues/114 ## 0.7.1 July 24 2017 - Fixed issue where internal file creation and modification dates were in the local timezone instead of UTC. Issue [#110][gh_110]. [gh_110]: https://github.com/jmcnamara/libxlsxwriter/issues/110 ## 0.7.0 June 26 2017 - Added support for CMake build system. Thanks to Alex Huszagh. - Fixed issue where image filehandles weren't closed until the overall file was closed causing the system to run out of filehandles. Issue [#106][gh_106]. [gh_106]: https://github.com/jmcnamara/libxlsxwriter/issues/106 ## 0.6.9 January 30 2017 - Added chart trendlines. See @ref chart_trendlines and @ref chart_data_tools.c. ## 0.6.8 January 28 2017 - Added chart error bars. See @ref chart_error_bars and @ref chart_data_tools.c. ## 0.6.7 January 24 2017 - Added chart data labels. See @ref chart_labels. ## 0.6.6 January 22 2017 - Added functions to set chart Up-Down bars: see `chart_set_up_down_bars()` and `chart_set_up_down_bars_format()` and @ref chart_data_tools.c. - Added functions to handle blank and hidden data in charts: see `chart_show_blanks_as()` and `chart_show_hidden_data()`. ## 0.6.5 January 21 2017 - Added functions to set the overlap and gap between series: see `chart_set_series_overlap()` and `chart_set_series_gap()`. ## 0.6.4 January 20 2017 - Added chart data table option, see `chart_set_table()` and `chart_set_table_grid()`. - Added Clustered Chart example, see @ref chart_clustered.c. ## 0.6.3 January 19 2017 - Added `chart_set_drop_lines()` and `chart_set_high_low_lines()` functions to add chart Drop and High-Low lines to indicate category values. See @ref chart_data_tools.c. ## 0.6.2 January 17 2017 - Added `chart_series_set_smooth()` function to set the line smoothing property of a line or scatter chart series. ## 0.6.1 January 16 2017 - Added option to set formatting for points in a chart. This allow the colors of Pie chart segments to be defined. See @ref chart_points. ## 0.6.0 January 15 2017 - Added option to set the number format for a chart axis, see `chart_axis_set_num_format()`. - Added "invert if negative" option for series fills, see `chart_series_set_invert_if_negative()`. ## 0.5.9 January 14 2017 - Added support for chart axis crossing. See `chart_axis_set_crossing()` and `chart_axis_set_crossing_max()`. ## 0.5.8 January 13 2017 - Added `chart_axis_set_major_tick_mark()` and `chart_axis_set_minor_tick_mark()` functions to chart axis tick marks. ## 0.5.7 January 12 2017 - Added `chart_axis_set_display_units()` function to set chart axis display units. ## 0.5.6 January 11 2017 - Added `chart_axis_set_interval_unit()` and `chart_axis_set_interval_tick()` functions to adjust category axis intervals. ## 0.5.5 January 10 2017 - Added `chart_axis_set_major_unit()` and `chart_axis_set_minor_unit()` to set the major and minor units of a category axis. ## 0.5.4 January 9 2017 - Added `chart_axis_set_label_position()` option to position the axis labels (numbers). - Improved documentation for @ref ww_charts_axes. ## 0.5.3 January 8 2017 - Added `chart_axis_set_position()` option to position a category axis horizontally on, or between, the axis tick marks. ## 0.5.2 January 7 2017 - Added option to turn off chart axis: `chart_axis_off()`. ## 0.5.1 January 6 2017 - Added chart major and minor gridlines handling, see: - `chart_axis_major_gridlines_set_visible()` - `chart_axis_minor_gridlines_set_visible()` - `chart_axis_major_gridlines_set_line()` - `chart_axis_minor_gridlines_set_line()` ## 0.5.0 January 5 2017 - Added chart and plot area formatting. See `chart_chartarea_set_line()` and `chart_plotarea_set_line()`. ## 0.4.9 January 4 2017 - Added support for chart patterns. See @ref chart_patterns. ## 0.4.8 January 3 2017 - Added support for chart markers. See @ref chart_markers. ## 0.4.7 January 2 2017 - Added `chart_axis_set_reverse()` function to reverse the order of a chart axis. - Added `chart_axis_set_min()`and `chart_axis_set_max()` functions to set the minimum and maximum value for a chart axis. - Added `chart_axis_set_log_base()` function to set the log base of a chart axis. Feature request [#70][gh_70]. [gh_70]: https://github.com/jmcnamara/libxlsxwriter/issues/70 ## 0.4.6 January 1 2017 - Added functions to set chart line and fill properties, see: - `chart_series_set_line()`. Feature request [#83][gh_83]. - `chart_series_set_fill()`. - `chart_axis_set_line()`. - `chart_axis_set_fill()`. - @ref chart_lines. - @ref chart_fills. [gh_83]: https://github.com/jmcnamara/libxlsxwriter/issues/83 ## 0.4.5 December 31 2016 - Added functions to set chart legend properties: see `chart_legend_set_position()`, `chart_legend_set_font()` and `chart_legend_delete_series()`. ## 0.4.4 December 30 2016 - Added chart fonts. See `chart_axis_set_name_font()`, `chart_axis_set_num_font()`, `chart_title_set_name_font()` and @ref chart_fonts. ## 0.4.3 December 26 2016 - Added `workbook_get_worksheet_by_name()` function to get a worksheet object from its name. - Added `workbook_validate_worksheet_name()` function to validate a worksheet name. - Fix for parameter length check when strings are UTF-8. Issue [#84][gh_84]. [gh_84]: https://github.com/jmcnamara/libxlsxwriter/issues/84 ## 0.4.2 July 14 2016 - Added support for OpenBSD and better support for FreeBSD. See @ref gsg_bsd. ## 0.4.1 July 11 2016 - Switched to using [tmpfileplus](http://www.di-mgt.com.au/c_function_to_create_temp_file.html) for temporary file handles to work around issue when the temp directory on Windows isn't writeable. The temp file directory is now also configurable at runtime, see @ref gsg_tmpdir. Issue [#63][gh_63]. [gh_63]: https://github.com/jmcnamara/libxlsxwriter/issues/63 ## 0.4.0 July 5 2016 - Added fixes for MSVC 2010. - Refactored public APIs to return #lxw_error instead of int. ## 0.3.9 July 2 2016 - Added support for MinGW, MinGW-w64, Cygwin, MSYS and MSYS2. See @ref gsg_ming. ## 0.3.8 June 11 2016 - Added workbook functions to set custom document properties. See `workbook_set_custom_property_string()` and @ref doc_custom_properties.c. ## 0.3.7 June 2 2016 - Added updated Cocoapods file for Cocoapods 1.0.0. This also add support for the "use_frameworks" directive. Thanks to Ludovico Rossi. See @ref getting_started for instructions on how to use the cocoapod. Pull request [#50][gh_50]. [gh_50]: https://github.com/jmcnamara/libxlsxwriter/issues/50 ## 0.3.6 June 1 2016 - Fix for `worksheet_insert_image()` issue when handling images with zero dpi. ## 0.3.5 May 31 2016 - Refactored the error handling and reporting for when the file creation subsystem fails due to file permissions or other issues. The new error codes are in `#lxw_error` and the codes can be converted to strings, for reporting, using the new `lxw_strerror()` function. Issue [#49][gh_49]. [gh_49]: https://github.com/jmcnamara/libxlsxwriter/issues/49 ## 0.3.4 May 28 2016 - Updated the @ref getting_started docs with instructions on how to build libxlsxwriter for Windows using Microsoft Visual Studio and added links to the example MSVC project: [MSVCLibXlsxWriter](https://github.com/jmcnamara/MSVCLibXlsxWriter). ## 0.3.3 May 23 2016 - Added support for charts via the @ref chart.h "The Chart object". See the examples of the supported chart types: - @ref chart_area.c "Area chart" - @ref chart_bar.c "Bar chart" - @ref chart_column.c "Column chart" - @ref chart_line.c "Line chart" - @ref chart_scatter.c "Scatter chart" - @ref chart_radar.c "Radar chart" - @ref chart_pie.c "Pie chart" - @ref chart_doughnut.c "Doughnut chart" - @ref chart_styles.c "Built-in charts styles" Feature request [#36][gh_36]. [gh_36]: https://github.com/jmcnamara/libxlsxwriter/issues/36 ## 0.3.2 April 8 2016 - Added the `worksheet_write_boolean()` function to write Excel boolean values. Feature request [#47][gh_47]. [gh_47]: https://github.com/jmcnamara/libxlsxwriter/issues/47 ## 0.3.1 January 9 2016 - Improved performance 20-30% for large data files. ## 0.3.0 January 4 2016 - Renamed `worksheet_set_row()` function to `worksheet_set_row_opt()` for consistency with current and future APIs. The `worksheet_set_row()` function is now used without the options parameter. Note: This is a backward incompatible change. - Renamed `worksheet_set_column()` function to `worksheet_set_column_opt()` for consistency with current and future APIs. The `worksheet_set_column()` function is now used without the options parameter. Note: This is a backward incompatible change. ## 0.2.9 January 3 2016 - Added the `worksheet_insert_image()` function to add PNG and JPG images to worksheets. See @ref demo.c and @ref images.c. ## 0.2.8 December 22 2015 - Added `worksheet_set_default_row()` function to allow setting of default row height and hiding unused rows. See the @ref hide_row_col.c example. ## 0.2.7 December 21 2015 - Added support for escaping control characters in strings. This prevents unreadable files if string data contains control characters. Issue [#42][gh_42]. [gh_42]: https://github.com/jmcnamara/libxlsxwriter/issues/42 ## 0.2.6 December 19 2015 - Added `worksheet_protect()` function to protect Excel worksheet elements from modification. See the @ref worksheet_protection.c example. ## 0.2.5 December 14 2015 - Added `workbook_set_properties()` function to set Excel document properties such as Author and Title. See the @ref doc_properties.c example. ## 0.2.4 December 13 2015 - Added `worksheet_hide()` function to hide a worksheet. See the @ref hide_sheet.c example. - Added `worksheet_set_first_sheet()` function to set the first visible worksheet in a workbook with a large number of worksheets. ## 0.2.3 December 12 2015 - Added `worksheet_set_tab_color()` function to set the worksheet tab color. See the @ref tab_colors.c example. ## 0.2.2 December 11 2015 - Replaced shared strings hash table with a Red/Black tree implementation for better performance. Thanks to Martin Renters. Pull Request [#41][gh_41]. [gh_41]: https://github.com/jmcnamara/libxlsxwriter/issues/41 ## 0.2.1 December 11 2015 - Added `worksheet_right_to_left()` function. This can be used to change the default direction of the worksheet from left-to-right when creating Arabic, Hebrew or other near or far eastern worksheets that use right-to-left as the default direction. - Added `worksheet_hide_zero()` function to hide zero cell values. - Added `worksheet_set_zoom()` method to set the worksheet zoom factor. ## 0.2.0 December 9 2015 - Added `worksheet_set_selection()` function to set the cell selected range on a worksheet. ## 0.1.9 December 7 2015 - Replaced main worksheet data structure with a Red/Black tree implementation for better performance when data isn't added in linear row-column order. Thanks to Martin Renters. Pull Request [#14][gh_14] and [#16][gh_16]. [gh_14]: https://github.com/jmcnamara/libxlsxwriter/issues/14 [gh_16]: https://github.com/jmcnamara/libxlsxwriter/issues/16 ## 0.1.8 December 7 2015 - Added `worksheet_freeze_panes()` and `worksheet_split_panes()` to allow setting worksheet panes. See @ref panes.c example. - Added link to [Xcode project][libxlsxwriterCocoaExamples] for iOS and OS X with Objective-C and Swift, provided by Ludovico Rossi. - Added improved support for Windows. [libxlsxwriterCocoaExamples]: https://github.com/lrossi/libxlsxwriterCocoaExamples ## 0.1.7 September 27 2015 - Fixed Cocoapod spec file for iOS and OS X. ## 0.1.6 September 27 2015 - Added Cocoapod spec file to allow the library to be installed using [CocoaPods](https://cocoapods.org). Pull Request [#7](https://github.com/jmcnamara/libxlsxwriter/issues/7). ## 0.1.5 May 3 2015 - Added `worksheet_write_url()` function to write urls/hyperlinks to worksheets. See also @ref hyperlinks.c. ## 0.1.4 March 18 2015 - Added `worksheet_autofilter()` function to add autofilters to worksheets. See also @ref autofilter.c. ## 0.1.3 March 15 2015 - Added `worksheet_write_array_formula()` function to allow writing of array formulas in worksheets. ## 0.1.2 March 14 2015 - Added `worksheet_set_h_pagebreaks()` and `worksheet_set_v_pagebreaks()` functions to define worksheet page breaks. - Added LXW_FOREACH_WORKSHEET() macro to allow iteration over all the worksheets in a workbook. - Added `worksheet_set_print_scale()` function to set the scale factor for the printed page. - Added `worksheet_set_start_page()` function to set the start page number when printing. ## 0.1.1 March 13 2015 - Added `worksheet_print_area()` function to control the print area of a worksheet. - Added `worksheet_fit_to_pages()` function to fit the printed area to a specific number of pages both vertically and horizontally. ## 0.1.0 March 12 2015 - Added `worksheet_repeat_rows()` and `worksheet_repeat_columns()` functions to control the repeated rows/columns on printed worksheets. ## 0.0.9 March 9 2015 - Added `worksheet_gridlines()` function to show/hide screen and print gridlines. - Added `worksheet_center_horizontally()` and `worksheet_center_vertically()` functions to center worksheet on the printed page. - Added `worksheet_print_row_col_headers()` function to enable printing of row and column headers. ## 0.0.8 March 8 2015 - Added support for worksheet headers and footers via the `worksheet_set_header()` and `worksheet_set_footer()` functions. See also @ref headers_footers.c. ## 0.0.7 March 7 2015 - Added the `worksheet_merge_range()` method to merge worksheet cells. See also @ref merge_range.c. ## 0.0.6 March 5 2015 - Added the `workbook_define_name()` method to create defined names and ranges in a workbook or worksheet. ## 0.0.5 March 6 2015 - Added `worksheet_select()` function to set worksheets as selected. - Added `worksheet_activate()` to set the active worksheet. - Several portability fixes to fix warnings with different compilers. ## 0.0.4 March 1 2015 - Added `worksheet_set_margins()` function to set top, bottom, left and right margins in a worksheet. - Fix for issue where format objects were written to the file in the order of creation rather than the order of use. This issue caused incorrect formats in cells. Issue [#3](https://github.com/jmcnamara/libxlsxwriter/issues/3). - Fix for issue where tmp files in `constant_memory` mode weren't closed until application exited. Issue [#1](https://github.com/jmcnamara/libxlsxwriter/issues/1). ## 0.0.3 January 7 2015 - Added worksheet page setup methods. - `worksheet_set_landscape()` - `worksheet_set_portrait()` - `worksheet_set_page_view()` - `worksheet_set_paper()` - `worksheet_print_across()` ## 0.0.2 June 26 2014 - First public release. ## 0.0.1 June 8 2014 - First GitHub release. */ libxlsxwriter-RELEASE_1.1.5/License.txt000066400000000000000000000236001435360132600177270ustar00rootroot00000000000000/** @page license License Libxlsxwriter is released under a FreeBSD license: Copyright 2014-2022, John McNamara All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project. Libxlsxwriter includes the `queue.h` and `tree.h` macros from FreeBSD. It also includes and, unless overridden, uses the optional libraries `minizip`, `tmpfileplus` and `md5`. It also includes the `emyg_dtoa` library but doesn't use it by default. These components have the following licenses: Queue.h from FreeBSD: Copyright (c) 1991, 1993 The Regents of the University of California. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 4. Neither the name of the University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Tree.h from FreeBSD: Copyright 2002 Niels Provos All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The `minizip` files used in the libxlsxwriter source tree are taken from the `zlib` ` contrib/minizip` directory. [Zlib](http://www.zlib.net) has the following License/Copyright: (C) 1995-2013 Jean-loup Gailly and Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Jean-loup Gailly Mark Adler jloup@gzip.org madler@alumni.caltech.edu The `minizip` files have the following additional copyright declarations: Copyright (C) 1998-2010 Gilles Vollant (minizip) ( http://www.winimage.com/zLibDll/minizip.html ) Modifications for Zip64 support Copyright (C) 2009-2010 Mathias Svensson ( http://result42.com ) Note, it is possible to compile libxlsxwriter without statically linking the `minizip` files and instead dynamically linking to `lminizip`, see @ref gsg_minizip. [Tmpfileplus](http://www.di-mgt.com.au/c_function_to_create_temp_file.html) has the following license: This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. Copyright (c) 2012-16 David Ireland, DI Management Services Pty Ltd . See the [Mozilla Public License, v. 2.0](http://mozilla.org/MPL/2.0/). Note, it is possible to compile libxlsxwriter using the standard library `tmpfile()` function instead of `tmpfileplus`, see @ref gsg_tmpdir. The [Milo Yip DTOA library](https://github.com/miloyip/dtoa-benchmark) for converting doubles to strings. It has the following license: Copyright (C) 2015 Doug Currie based on dtoa_milo.h Copyright (C) 2014 Milo Yip Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. This Milo Yip DTOA library (emyg_dtoa) is used to avoid issues where the standard sprintf() dtoa function changes output based on locale settings. It is also 40-50% faster than the standard dtoa for raw numeric data. The use of this library is optional. If you wish to use it you can pass `USE_DTOA_LIBRARY=1` to make when compiling. [Openwall MD5](https://openwall.info/wiki/people/solar/software/public-domain-source-code/md5) has the following licence: This software was written by Alexander Peslyak in 2001. No copyright is claimed, and the software is hereby placed in the public domain. In case this attempt to disclaim copyright and place the software in the public domain is deemed null and void, then the software is Copyright (c) 2001 Alexander Peslyak and it is hereby released to the general public under the following terms: Redistribution and use in source and binary forms, with or without modification, are permitted. There's ABSOLUTELY NO WARRANTY, express or implied. (This is a heavily cut-down "BSD license".) Note, the MD5 library is used to avoid including duplicate image files in the xlsx file. If you don't want to use this code, and the additional licence, you can use OpenSSL's MD5 functions instead by passing `USE_OPENSSL_MD5=1` to make. If this functionality isn't required it is possible to compile libxlsxwriter without image deduplication by passing `USE_NO_MD5=1` to make. See also @ref gsg_md5. Next: @ref changes */ libxlsxwriter-RELEASE_1.1.5/Makefile000066400000000000000000000205731435360132600172520ustar00rootroot00000000000000############################################################################### # # Makefile for libxlsxwriter library. # # Copyright 2014-2022, John McNamara, jmcnamara@cpan.org # # Keep the output quiet by default. Q=@ ifdef V Q= endif DESTDIR ?= PREFIX ?= /usr/local PYTEST ?= py.test PYTESTFILES ?= test VERSION = $(shell sed -n -e 's/.*LXW_VERSION \"\(.*\)\"/\1/p' include/xlsxwriter.h) SOVERSION = $(shell sed -n -e 's/.*LXW_SOVERSION \"\(.*\)\"/\1/p' include/xlsxwriter.h) .PHONY: docs tags examples third_party # Build libxlsxwriter. all : third_party $(Q)$(MAKE) -C src # Build the third party libs. third_party : ifndef USE_SYSTEM_MINIZIP $(Q)$(MAKE) -C third_party/minizip endif ifndef USE_STANDARD_TMPFILE $(Q)$(MAKE) -C third_party/tmpfileplus endif ifndef USE_NO_MD5 ifndef USE_OPENSSL_MD5 $(Q)$(MAKE) -C third_party/md5 endif endif ifdef USE_DTOA_LIBRARY $(Q)$(MAKE) -C third_party/dtoa endif # Build a macOS universal binary. universal_binary : $(Q)$(MAKE) clean $(Q)TARGET_ARCH="-target x86_64-apple-macos10.12" $(MAKE) all $(Q)mv lib/libxlsxwriter.a libxlsxwriter_x86_64.a $(Q)mv lib/libxlsxwriter.$(SOVERSION).dylib libxlsxwriter_x86_64.dylib $(Q)$(MAKE) clean $(Q)TARGET_ARCH="-target arm64-apple-macos11" $(MAKE) all $(Q)mv lib/libxlsxwriter.a lib/libxlsxwriter_arm64.a $(Q)mv lib/libxlsxwriter.$(SOVERSION).dylib lib/libxlsxwriter_arm64.dylib $(Q)mv libxlsxwriter_x86_64.a libxlsxwriter_x86_64.dylib lib $(Q)lipo -create -output lib/libxlsxwriter.a lib/libxlsxwriter_x86_64.a lib/libxlsxwriter_arm64.a $(Q)lipo -create -output lib/libxlsxwriter.$(SOVERSION).dylib lib/libxlsxwriter_x86_64.dylib lib/libxlsxwriter_arm64.dylib $(Q)rm -f lib/libxlsxwriter_x86_64.* lib/libxlsxwriter_arm64.* # Build the example programs. examples : all $(Q)$(MAKE) -C examples # Clean src and test directories. clean : $(Q)$(MAKE) clean -C src $(Q)$(MAKE) clean -C test/unit $(Q)$(MAKE) clean -C test/functional/src $(Q)$(MAKE) clean -C test/cpp $(Q)$(MAKE) clean -C examples $(Q)rm -rf docs/html $(Q)rm -rf test/functional/__pycache__ $(Q)rm -f test/functional/*.pyc $(Q)rm -f lib/* $(Q)$(MAKE) clean -C third_party/minizip $(Q)$(MAKE) clean -C third_party/tmpfileplus $(Q)$(MAKE) clean -C third_party/md5 $(Q)$(MAKE) clean -C third_party/dtoa # Clean src and lib dir only, as a precursor for static analysis. clean_src : $(Q)$(MAKE) clean -C src $(Q)rm -f lib/* # Run the unit tests. test : all test_cpp test_unit test_functional # Test for C++ const correctness on APIs. test_const : all $(Q)$(MAKE) clean -C test/functional/src $(Q)! $(MAKE) -C test/functional/src CFLAGS=-Wwrite-strings 2>&1 | grep -A 1 "note:" # Run the functional tests. test_functional : all $(Q)$(MAKE) -C test/functional/src $(Q)$(PYTEST) test/functional -v -k $(PYTESTFILES) # Run all tests. test_unit : all $(Q)$(MAKE) -C src test_lib $(Q)$(MAKE) -C test/unit test # Test C++ compilation. test_cpp : all $(Q)$(MAKE) -C test/cpp # Test Cmake. This test should really be done with Cmake in the cmake dir but # this is a workaround for now. test_cmake : ifneq ($(findstring m32,$(CFLAGS)),m32) $(Q)$(MAKE) -C src clean $(Q)cd cmake; cmake .. -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON; make clean; make; cp libxlsxwriter.a ../src/ $(Q)cmake/xlsxwriter_unit $(Q)$(MAKE) -C test/functional/src $(Q)$(PYTEST) test/functional -v -k $(PYTESTFILES) else @echo "Skipping Cmake tests on 32 bit target." endif # Test the functional test exes with valgrind (in 64bit mode only). test_valgrind : all ifndef NO_VALGRIND $(Q)$(MAKE) -C test/functional/src test_valgrind $(Q)$(MAKE) -C examples test_valgrind endif # Minimal target for quick compile without creating the libs. test_compile : $(Q)$(MAKE) -C src test_compile # Indent the source files with the .indent.pro settings. indent: $(Q)gindent src/*.c include/*.h include/xlsxwriter/*.h tags: $(Q)rm -f TAGS $(Q)etags src/*.c include/*.h include/xlsxwriter/*.h # Build the doxygen docs. doc: docs docs: $(Q)$(MAKE) -C docs @echo "Docs built." docs_doxygen_only: $(Q)$(MAKE) -C docs docs_doxygen_only docs_external: $(Q)make -C ../libxlsxwriter.github.io release # Simple install. install: all $(Q)mkdir -p $(DESTDIR)$(PREFIX)/include $(Q)cp -R include/* $(DESTDIR)$(PREFIX)/include $(Q)mkdir -p $(DESTDIR)$(PREFIX)/lib $(Q)cp -R lib/* $(DESTDIR)$(PREFIX)/lib $(Q)mkdir -p $(DESTDIR)$(PREFIX)/lib/pkgconfig $(Q)sed -e 's|@PREFIX@|$(PREFIX)|g' -e 's|@VERSION@|$(VERSION)|g' dev/release/pkg-config.txt > $(DESTDIR)$(PREFIX)/lib/pkgconfig/xlsxwriter.pc # Simpler uninstall. uninstall: $(Q)rm -rf $(DESTDIR)$(PREFIX)/include/xlsxwriter* $(Q)rm $(DESTDIR)$(PREFIX)/lib/libxlsxwriter.* $(Q)rm $(DESTDIR)$(PREFIX)/lib/pkgconfig/xlsxwriter.pc # Strip the lib files. strip: $(Q)strip lib/* # Run a coverity static analysis. coverity: clean_src third_party $(Q)rm -rf cov-int $(Q)rm -f libxlsxwriter-coverity.tgz $(Q)../../cov-analysis-linux64-2019.03/bin/cov-build --dir cov-int make -C src libxlsxwriter.a $(Q)tar -czf libxlsxwriter-coverity.tgz cov-int $(Q)$(MAKE) -C src clean $(Q)rm -f lib/* # Run gcov coverage analysis. gcov: third_party $(Q)$(MAKE) -C src clean $(Q)$(MAKE) -C src GCOV="--coverage" OPT_LEVEL="-O0" $(Q)$(MAKE) -C src test_lib GCOV="--coverage" $(Q)$(MAKE) -C test/unit test GCOV="--coverage" $(Q)$(MAKE) -C test/functional/src GCOV="--coverage" $(Q)$(PYTEST) test/functional -v -k $(PYTESTFILES) $(Q)mkdir -p build $(Q)gcovr -r src --html-details -o build/libxlsxwriter_gcov.html $(Q)gcovr -r . -f src --sonarqube build/coverage.xml # Run sonarcloud analysis. sonarcloud: gcov ifndef SONAR_TOKEN @echo "Please define SONAR_TOKEN to run this analysis." @exit 1 endif $(Q)$(MAKE) clean $(Q)../sonar-scanner-4.6.1.2450-macosx/bin/build-wrapper-macosx-x86 --out-dir build make all $(Q)../sonar-scanner-4.6.1.2450-macosx/bin/sonar-scanner \ -Dsonar.organization=jmcnamara-github \ -Dsonar.projectKey=jmcnamara_libxlsxwriter \ -Dsonar.projectName=libxlsxwriter \ -Dsonar.projectVersion=$(VERSION) \ -Dsonar.sources=src \ -Dsonar.sourceEncoding=UTF-8 \ -Dsonar.cfamily.build-wrapper-output=build \ -Dsonar.working.directory=build/scannerwork \ -Dsonar.host.url=https://sonarcloud.io \ -Dsonar.cfamily.threads=4 \ -Dsonar.coverageReportPaths=build/coverage.xml \ -Dsonar.cfamily.cache.enabled=false sonarcloud_no_gcov: ifndef SONAR_TOKEN @echo "Please define SONAR_TOKEN to run this analysis." @exit 1 endif $(Q)$(MAKE) clean $(Q)../sonar-scanner-4.6.1.2450-macosx/bin/build-wrapper-macosx-x86 --out-dir build make all $(Q)../sonar-scanner-4.6.1.2450-macosx/bin/sonar-scanner \ -Dsonar.organization=jmcnamara-github \ -Dsonar.projectKey=jmcnamara_libxlsxwriter \ -Dsonar.projectName=libxlsxwriter \ -Dsonar.projectVersion=$(VERSION) \ -Dsonar.sources=src \ -Dsonar.sourceEncoding=UTF-8 \ -Dsonar.cfamily.build-wrapper-output=build \ -Dsonar.working.directory=build/scannerwork \ -Dsonar.host.url=https://sonarcloud.io \ -Dsonar.cfamily.threads=4 \ -Dsonar.cfamily.cache.enabled=false # Run a scan-build static analysis. scan_build: clean_src third_party $(Q)scan-build make -C src libxlsxwriter.a $(Q)$(MAKE) -C src clean $(Q)rm -f lib/* spellcheck: $(Q)for f in docs/src/*.dox; do aspell --lang=en_US --check $$f; done $(Q)for f in include/xlsxwriter/*.h; do aspell --lang=en_US --check $$f; done $(Q)for f in src/*.c; do aspell --lang=en_US --check $$f; done $(Q)for f in examples/*.c; do aspell --lang=en_US --check $$f; done $(Q)aspell --lang=en_US --check Changes.txt $(Q)aspell --lang=en_US --check Readme.md $(Q)aspell --lang=en_US --check docs/src/examples.txt releasecheck: $(Q)dev/release/release_check.sh release: releasecheck @echo @echo "Pushing to git main ..." $(Q)git push origin main $(Q)git push --tags @echo @echo "Pushing updated docs ..." $(Q)make -C ../libxlsxwriter.github.io release @echo @echo "Pushing the cocoapod ..." $(Q)pod trunk push libxlsxwriter.podspec --use-libraries @echo @echo "Finished. Opening files." $(Q)open https://libxlsxwriter.github.io/changes.html $(Q)open https://cocoadocs.org/docsets/libxlsxwriter $(Q)open https://github.com/jmcnamara/libxlsxwriter $(Q)open https://github.com/jmcnamara/libxlsxwriter/releases libxlsxwriter-RELEASE_1.1.5/Readme.md000066400000000000000000000043071435360132600173260ustar00rootroot00000000000000# libxlsxwriter Libxlsxwriter: A C library for creating Excel XLSX files. ![demo image](http://libxlsxwriter.github.io/demo.png) ## The libxlsxwriter library Libxlsxwriter is a C library that can be used to write text, numbers, formulas and hyperlinks to multiple worksheets in an Excel 2007+ XLSX file. It supports features such as: - 100% compatible Excel XLSX files. - Full Excel formatting. - Merged cells. - Defined names. - Autofilters. - Charts. - Data validation and drop down lists. - Conditional formatting. - Worksheet PNG/JPEG/GIF images. - Cell comments. - Support for adding Macros. - Memory optimization mode for writing large files. - Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter). - FreeBSD license. - ANSI C. - Works with GCC, Clang, Xcode, MSVC 2015, ICC, TCC, MinGW, MingGW-w64/32. - Works on Linux, FreeBSD, OpenBSD, OS X, iOS and Windows. Also works on MSYS/MSYS2 and Cygwin. - Compiles for 32 and 64 bit. - Compiles and works on big and little endian systems. - The only dependency is on `zlib`. Here is an example that was used to create the spreadsheet shown above: ```C #include "xlsxwriter.h" int main() { /* Create a new workbook and add a worksheet. */ lxw_workbook *workbook = workbook_new("demo.xlsx"); lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL); /* Add a format. */ lxw_format *format = workbook_add_format(workbook); /* Set the bold property for the format */ format_set_bold(format); /* Change the column width for clarity. */ worksheet_set_column(worksheet, 0, 0, 20, NULL); /* Write some simple text. */ worksheet_write_string(worksheet, 0, 0, "Hello", NULL); /* Text with formatting. */ worksheet_write_string(worksheet, 1, 0, "World", format); /* Write some numbers. */ worksheet_write_number(worksheet, 2, 0, 123, NULL); worksheet_write_number(worksheet, 3, 0, 123.456, NULL); /* Insert an image. */ worksheet_insert_image(worksheet, 1, 2, "logo.png"); workbook_close(workbook); return 0; } ``` See the [full documentation](http://libxlsxwriter.github.io) for the getting started guide, a tutorial, the main API documentation and examples. libxlsxwriter-RELEASE_1.1.5/cmake/000077500000000000000000000000001435360132600166635ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/cmake/FindMINIZIP.cmake000066400000000000000000000054471435360132600216170ustar00rootroot00000000000000# :copyright: (c) 2017 Alex Huszagh. # :license: FreeBSD, see LICENSE.txt for more details. # FindMINIZIP # ----------- # # Find MINIZIP include dirs and libraries # # Use this module by invoking find_package with the form:: # # find_package(MINIZIP # [version] [EXACT] # Minimum or EXACT version e.g. 1.0.6 # [REQUIRED] # Fail with error if MINIZIP is not found # ) # # You may also set `MINIZIP_USE_STATIC_LIBS` to prefer static libraries # to shared ones. # # If found, `MINIZIP_FOUND` will be set to true, and `MINIZIP_LIBRARIES` # and `MINIZIP_INCLUDE_DIRS` will both be set. # # You may optionally set `MINIZIP_ROOT` to specify a custom root directory # for the MINIZIP installation. # include(CheckCXXSourceCompiles) include(FindPackage) # PATHS # ----- set(MINIZIP_SEARCH_PATHS) if(MINIZIP_ROOT) list(APPEND MINIZIP_SEARCH_PATHS ${MINIZIP_ROOT}) endif() if(WIN32) list(APPEND ZLIB_SEARCH_PATHS "$ENV{PROGRAMFILES}/minizip" ) endif() unset(MINIZIP_SYSTEM_ROOT) unset(MINIZIP_CUSTOM_ROOT) unset(MINIZIP_SEARCH_HKEY) # FIND # ---- # INCLUDE DIRECTORY SetSuffixes(MINIZIP) foreach(search ${MINIZIP_SEARCH_PATHS}) FIND_PATH(MINIZIP_INCLUDE_DIR NAMES minizip/zip.h PATHS ${search} PATH_SUFFIXES include ) endforeach(search) if(NOT MINIZIP_INCLUDE_DIR) FIND_PATH(MINIZIP_INCLUDE_DIR minizip/zip.h PATH_SUFFIXES include) endif() # LIBRARY PATHS set(MINIZIP_LIBRARY_NAMES minizip) if(CMAKE_BUILD_TYPE MATCHES Debug) list(APPEND MINIZIP_LIBRARY_NAMES minizipd) endif() foreach(search ${MINIZIP_SEARCH_PATHS}) FIND_LIBRARY(MINIZIP_LIBRARY NAMES ${MINIZIP_LIBRARY_NAMES} PATHS ${search} PATH_SUFFIXES lib ) endforeach(search) if(NOT MINIZIP_LIBRARY) FIND_LIBRARY(MINIZIP_LIBRARY NAMES ${MINIZIP_LIBRARY_NAMES} PATH_SUFFIXES lib) endif() set(MINIZIP_INCLUDE_DIRS ${MINIZIP_INCLUDE_DIR}) set(MINIZIP_LIBRARIES ${MINIZIP_LIBRARY}) CheckFound(MINIZIP) FindStaticLibs(MINIZIP) # VERSION # ------- if(MINIZIP_FOUND) file(STRINGS "${MINIZIP_INCLUDE_DIRS}/zlib.h" MINIZIP_VERSION_CONTENTS REGEX "Version [0-9]+\\.[0-9]+(\\.[0-9]+)?") string(REGEX REPLACE ".*Version ([0-9]+)\\.[0-9]+" "\\1" MINIZIP_VERSION_MAJOR "${MINIZIP_VERSION_CONTENTS}") string(REGEX REPLACE ".*Version [0-9]+\\.([0-9]+)" "\\1" MINIZIP_VERSION_MINOR "${MINIZIP_VERSION_CONTENTS}") set(MINIZIP_VERSION_PATCH 0) set(MINIZIP_VERSION_STRING "${MINIZIP_VERSION_MAJOR}.${MINIZIP_VERSION_MINOR}.${MINIZIP_VERSION_PATCH}") set(MINIZIP_VERSION ${MINIZIP_VERSION_STRING}) MatchVersion(MINIZIP) endif() # COMPILATION # ----------- set(MINIZIP_CODE " #include int main(void) { zip_fileinfo zipfile_info; return 0; } " ) if(MINIZIP_FOUND) CheckCompiles(MINIZIP) endif() RequiredPackageFound(MINIZIP) libxlsxwriter-RELEASE_1.1.5/cmake/FindPackage.cmake000066400000000000000000000115271435360132600220270ustar00rootroot00000000000000# :copyright: (c) 2017 Alex Huszagh. # :license: FreeBSD, see LICENSE.txt for more details. # FindPackage # ----------- # # Macros and functions to help find packages. Do not invoke this module # directly, it merely provides library definitions to be invoked # by other find utilities. include(CheckCXXSourceCompiles) # Return if the package name has previously been found # # Args: # packageName Name of the package # # Example: # ReturnFound(Iconv) # macro(ReturnFound packageName) if(${packageName}_FOUND) return() endif() endmacro(ReturnFound) # Set the library extensions for a given package dependent on whether # to search for static or dynamic libraries. # # Args: # packageName Name of the package # # Example: # SetSuffixes(IConv) # macro(SetSuffixes packageName) if(${packageName}_USE_STATIC_LIBS) if(MSVC) set(CMAKE_FIND_LIBRARY_SUFFIXES ".lib") else() set(CMAKE_FIND_LIBRARY_SUFFIXES ".a") endif() else() if(WIN32) set(CMAKE_FIND_LIBRARY_SUFFIXES ".dll.a" ".dll" ".lib" ".a") else() set(CMAKE_FIND_LIBRARY_SUFFIXES ".so" ".a") endif() endif() endmacro(SetSuffixes) # Check if the package was found. # # Args: # packageName Name of the package # # Example: # CheckFound(IConv) # macro(CheckFound packageName) if(${packageName}_INCLUDE_DIRS AND ${packageName}_LIBRARIES) set(${packageName}_FOUND TRUE) endif() endmacro(CheckFound) # Replace a dynamic library with a `.dll.a` extension with the corresponding # library removing the `.dll`. # # Args: # libraryName Variable name for path to found library # # Example: # ReplaceDynamic(/mingw64/lib/libiconv.dll.a) # macro(ReplaceDynamic libraryName) if(${libraryName} MATCHES ".dll.a") string(REPLACE ".dll.a" ".a" static ${${libraryName}}) if(EXISTS ${static}) set(${libraryName} ${static}) endif() endif() endmacro(ReplaceDynamic) # Replace a dynamic libraries with the static variants, with integrity # checks for the package. # # Args: # packageName Name of the package # # Example: # FindStaticLibs(IConv) # macro(FindStaticLibs packageName) if(${packageName}_USE_STATIC_LIBS AND MSYS) # convert `.dll.a` to `.a` set(${packageName}_LIBRARY_SOURCE ${${packageName}_LIBRARIES}) set(${packageName}_LIBRARIES "") foreach(library ${${packageName}_LIBRARY_SOURCE}) # replace each dynamic library with a single one set(static_library ${library}) ReplaceDynamic(static_library) list(APPEND ${packageName}_LIBRARIES ${static_library}) endforeach(library) endif() endmacro(FindStaticLibs) # Checks if a suitable version for the found library was identified, # if provided. The library can either force exact or inexact matching. # # Args: # packageName Name of the package # # Example: # MatchVersion(ICU) # macro(MatchVersion packageName) if(${packageName}_FOUND AND ${packageName}_FIND_VERSION) # MATCH VERSION if(${packageName}_FIND_VERSION_EXACT) # EXACT VERSION if(${packageName}_FIND_VERSION VERSION_EQUAL ${packageName}_VERSION) else() set(${packageName}_FOUND FALSE) endif() else() # GREATER THAN VERSION if(${packageName}_VERSION VERSION_LESS ${packageName}_FIND_VERSION) set(${packageName}_FOUND FALSE) endif() endif() endif() endmacro(MatchVersion) # Check if a sample program compiles, if not, set the library to not found. # # Args: # packageName Name of the package # code String of simple program depending on the library # # Example: # set(IConv_CODE "int main(int argc, char **argv){ return 0; }") # CheckCompiles(IConv) # macro(CheckCompiles packageName) # FLAGS set(CMAKE_REQUIRED_INCLUDES ${${packageName}_INCLUDE_DIRS}) set(CMAKE_REQUIRED_LIBRARIES ${${packageName}_LIBRARIES}) # COMPILATION check_cxx_source_compiles("${${packageName}_CODE}" ${packageName}_COMPILES) if(NOT ${${packageName}_COMPILES}) set(${packageName}_FOUND FALSE) message(SEND_ERROR "Cannot compile a simple ${packageName} program.") endif() endmacro(CheckCompiles) # Send an error if a required package was not found. Otherwise, if the # package is found, report to the user it was identified. # # Args: # packageName Name of the package # # Example: # RequiredPackageFound(ICU) # macro(RequiredPackageFound packageName) if(${packageName}_FOUND) message("Found ${packageName}.") else() if(${packageName}_FIND_REQUIRED) message(SEND_ERROR "Unable to find requested ${packageName} libraries.") endif() endif() endmacro(RequiredPackageFound) libxlsxwriter-RELEASE_1.1.5/cmake/i686-toolchain.cmake000066400000000000000000000004611435360132600223400ustar00rootroot00000000000000set(CMAKE_SYSTEM_NAME Linux) set(CMAKE_SYSTEM_VERSION 1) set(CMAKE_SYSTEM_PROCESSOR "i686") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32" CACHE STRING "c++ flags") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32" CACHE STRING "c flags") set(CMAKE_ASM_FLAGS "${CMAKE_ASM_FLAGS} -m32" CACHE STRING "asm flags") libxlsxwriter-RELEASE_1.1.5/cocoapods/000077500000000000000000000000001435360132600175555ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/cocoapods/libxlsxwriter-umbrella.h000066400000000000000000000015401435360132600244510ustar00rootroot00000000000000#import #import "../xlsxwriter.h" #import "app.h" #import "chart.h" #import "chartsheet.h" #import "comment.h" #import "common.h" #import "content_types.h" #import "core.h" #import "custom.h" #import "drawing.h" #import "format.h" #import "hash_table.h" #import "metadata.h" #import "packager.h" #import "relationships.h" #import "shared_strings.h" #import "styles.h" #import "table.h" #import "theme.h" #import "third_party/emyg_dtoa.h" #import "third_party/ioapi.h" #import "third_party/md5.h" #import "third_party/queue.h" #import "third_party/tmpfileplus.h" #import "third_party/tree.h" #import "third_party/zip.h" #import "utility.h" #import "vml.h" #import "workbook.h" #import "worksheet.h" #import "xmlwriter.h" FOUNDATION_EXPORT double xlsxwriterVersionNumber; FOUNDATION_EXPORT const unsigned char xlsxwriterVersionString[]; libxlsxwriter-RELEASE_1.1.5/cocoapods/libxlsxwriter.modulemap000066400000000000000000000002261435360132600244040ustar00rootroot00000000000000framework module xlsxwriter { umbrella header "xlsxwriter/libxlsxwriter-umbrella.h" header "xlsxwriter.h" export * module * { export * } } libxlsxwriter-RELEASE_1.1.5/dev/000077500000000000000000000000001435360132600163615ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/dev/release/000077500000000000000000000000001435360132600200015ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/dev/release/Readme.txt000066400000000000000000000001421435360132600217340ustar00rootroot00000000000000 This directory contains some release utilities that are mainly useful to the library developer. libxlsxwriter-RELEASE_1.1.5/dev/release/fix_dox.sh000077500000000000000000000003201435360132600217730ustar00rootroot00000000000000#/bin/bash # Perform some minor clean-ups/fixes to the docs. perl -i -pe "s/_page/_8h/" html/pages.html perl -i ../dev/release/fix_example_docs.pl html/examples.html cp menudata.js html libxlsxwriter-RELEASE_1.1.5/dev/release/fix_example_docs.pl000066400000000000000000000142201435360132600236460ustar00rootroot00000000000000#!/usr/bin/perl # # Simple program to arrange the example programs in a user defined order # instead of a sorted order. Also add a caption. # # Copyright 2014-2022, John McNamara, jmcnamara@cpan.org # use warnings; use strict; # The required example order and descriptions. my @examples = ( [ 'hello.c', 'A simple hello world example' ], [ 'anatomy.c', 'The anatomy of a libxlsxwriter program' ], [ 'demo.c', 'Demo of some of the libxlsxwriter features' ], [ 'tutorial1.c', 'Tutorial 1 from the documentation' ], [ 'tutorial2.c', 'Tutorial 2 from the documentation' ], [ 'tutorial3.c', 'Tutorial 3 from the documentation' ], [ 'format_font.c', 'Example of writing data with font formatting' ], [ 'format_num_format.c', 'Example of writing data with number formatting' ], [ 'dates_and_times01.c', 'Writing dates and times with numbers' ], [ 'dates_and_times02.c', 'Writing dates and times with datetime' ], [ 'dates_and_times03.c', 'Writing dates and times with Unix datetimes' ], [ 'dates_and_times04.c', 'Dates and times with different formats' ], [ 'hyperlinks.c', 'A example of writing urls/hyperlinks' ], [ 'rich_strings.c', 'A example of writing "rich" multi-format strings' ], [ 'array_formula.c', 'A example of using array formulas' ], [ 'dynamic_arrays.c', 'A example of using Excel 365 dynamic array formulas' ], [ 'utf8.c', 'A example of some UTF-8 text' ], [ 'constant_memory.c', 'Write a large file with constant memory usage' ], [ 'output_buffer.c', 'Write a file to a memory buffer' ], [ 'image_buffer.c', 'Example of adding an image from a memory buffer.' ], [ 'merge_range.c', 'Create a merged range of cells' ], [ 'merge_rich_string.c', 'Create a merged range with a rich string' ], [ 'autofilter.c', 'An example of a worksheet autofilter' ], [ 'data_validate.c', 'Examples of worksheet data validation and drop down lists' ], [ 'conditional_format1.c', 'A simple conditional formatting example' ], [ 'conditional_format2.c', 'An advanced conditional formatting example' ], [ 'tables.c', 'Example of table to a worksheet.' ], [ 'images.c', 'Example of adding images to a worksheet.' ], [ 'headers_footers.c', 'Example of adding worksheet headers/footers' ], [ 'defined_name.c', 'Example of how to create defined names' ], [ 'outline.c', 'Example of grouping and outlines' ], [ 'outline_collapsed.c', 'Example of grouping and collapsed outlines' ], [ 'watermark.c', 'Example of how to set a watermark image for a worksheet' ], [ 'background.c', 'Example of how to set the background image for a worksheet' ], [ 'tab_colors.c', 'Example of how to set worksheet tab colors' ], [ 'diagonal_border.c', 'Example of how to set a worksheet cell diagonal border.' ], [ 'hide_sheet.c', 'Example of hiding a worksheet' ], [ 'doc_properties.c', 'Example of setting workbook doc properties' ], [ 'doc_custom_properties.c','Example of setting custom doc properties' ], [ 'worksheet_protection.c', 'Example of enabling worksheet protection' ], [ 'hide_row_col.c', 'Example of hiding worksheet rows and columns' ], [ 'comments1.c', 'Example of adding cell comments to a worksheet' ], [ 'comments2.c', 'Example of adding cell comments with options' ], [ 'macro.c', 'Example of adding a VBA macro to a workbook' ], [ 'panes.c', 'Example of how to create worksheet panes' ], [ 'ignore_errors.c', 'Example of ignoring worksheet errors/warnings' ], [ 'lambda.c', 'Example of using the EXCEL 365+ LAMBDA() function' ], [ 'chart.c', 'Example of a simple column chart' ], [ 'chart_area.c', 'Examples of area charts' ], [ 'chart_bar.c', 'Examples of bar charts' ], [ 'chart_column.c', 'Examples of column charts' ], [ 'chart_line.c', 'Example of a line chart' ], [ 'chart_scatter.c', 'Examples of scatter charts' ], [ 'chart_radar.c', 'Examples of radar charts' ], [ 'chart_pie.c', 'Examples of pie charts' ], [ 'chart_doughnut.c', 'Examples of doughnut charts' ], [ 'chart_clustered.c', 'Examples of clustered category chart' ], [ 'chart_data_table.c', 'Examples of charts with data tables' ], [ 'chart_data_tools.c', 'Examples of charts data tools' ], [ 'chart_data_labels.c', 'Examples of charts data labels' ], [ 'chart_fonts.c', 'Examples of using charts fonts' ], [ 'chart_pattern.c', 'Examples of using charts patterns' ], [ 'chart_styles.c', 'Examples of built-in charts styles' ], [ 'chartsheet.c', 'Example of a chartsheet chart' ], ); # Convert the array refs to a hash for lookups. my %examples; for my $example (@examples) { $examples{$example->[0]} = 1; } my $in_list = 0; while ( my $line = <> ) { # Print all lines not in the
    list. print $line if !$in_list; # Check for
      list. if ( $line =~ /
      / ) { $in_list = 1; } # Capture the
    • items of the list. if ( $line =~ /
    • ([^<]+)/ ) { my $example = $1; # Warn if there are any new/unkown items. if ( !exists $examples{$example} ) { warn "$0 Unknown example: $example\n"; } next; } # At the end of the
        list print out the
      • items in user defined order. if ( $line =~ m{^
      } ) { $in_list = 0; for my $aref ( @examples ) { my $example = $aref->[0]; my $filename = $aref->[0]; my $desc = $aref->[1]; $example =~ s/\.c/_8c-example.html/; printf qq(
    • %s %s
    • \n\n), $example, $filename, $desc; } print $line; } } __END__ libxlsxwriter-RELEASE_1.1.5/dev/release/fix_example_links.pl000066400000000000000000000035221435360132600240410ustar00rootroot00000000000000#!/usr/bin/perl # # Simple program to generate the examples.dox file from a simple text file, # with links to the next/previous examples. # # Copyright 2014-2022, John McNamara, jmcnamara@cpan.org # use strict; use warnings; my @examples; my @sections; my @links; my $buffer = ''; # Sample through the example sections and break the text into blocks. while ( my $line = <> ) { # Ignore comments in the input file. next if $line =~ /^#/; # Match the start of an example block. if ( $line =~ /^\@example/ ) { chomp $buffer; # Store the example name and the section body. push @examples, $line; push @sections, $buffer; $buffer = ''; next; } $buffer .= $line; } # Store the last example section and omit the first blank element. push @sections, $buffer; shift @sections; # Generate a set of @ref links targets from the example program names. for ( @examples ) { my $link = $_; chomp $link; $link =~ s/\@example //; push @links, [ $link, $link ]; } # Add the first and last links back to the examples. unshift @links, [ "examples", "Examples page" ]; push @links, [ "examples", "Examples page" ]; # Add the start of the Doxygen header. print "/**\n"; print "\@page examples Example Programs\n\n"; # Print out each section. for my $i ( 0 .. @examples - 1 ) { print $examples[$i]; # Add a simple header table with next/previous links. printf qq{\n\n}; printf qq{\n}; printf qq{ \n}, $links[$i]->[0], $links[$i]->[1]; printf qq{ \n}, $links[ $i + 2 ]->[0], $links[ $i + 2 ]->[1]; printf qq{\n}; printf qq{
      \@ref %s "<< %s"\@ref %s "%s >>"
      \n}; print $sections[$i], "\n\n\n\n"; } # Print the end of the doxygen comment. print "*/\n"; libxlsxwriter-RELEASE_1.1.5/dev/release/gen_error_strings.pl000066400000000000000000000020631435360132600240720ustar00rootroot00000000000000#!/usr/bin/perl # # Simple program to generate the string array for the lxw_strerror() function # from the Doxygen comments in the lxw_error enum: # # perl dev/release/gen_error_strings.pl include/xlsxwriter/common.h # # Copyright 2014-2022, John McNamara, jmcnamara@cpan.org # use warnings; use strict; my $in_enum = 0; my @strings; my $filename = shift || 'include/xlsxwriter/common.h'; open my $fh, '<', $filename or die "Couldn't open $filename: $!\n"; while (<$fh>) { $in_enum = 1 if /typedef enum lxw_error/; $in_enum = 0 if /} lxw_error;/; # Match doxygen strings in the enum. if ($in_enum && m{/\*\*}) { # Strip the comment parts. s{/\*\*}{}; s{\*/}{}; s{^\s+}{}; s{\s+$}{}; push @strings, $_; } } # Print out an array of strings based on the doxygen comments. print "\n"; print "// Copy to src/utility.c\n\n"; print "char *error_strings[LXW_MAX_ERRNO + 1] = {\n"; for my $string (@strings) { print qq{ "$string",\n}; } print qq{ "Unknown error number."\n}; print "};\n\n"; libxlsxwriter-RELEASE_1.1.5/dev/release/gen_umbrella_file.pl000066400000000000000000000015671435360132600240020ustar00rootroot00000000000000#!/usr/bin/perl # # Simple program to generate the coccoapods unbrella file. # Run from the libxlsxwriter root dir. # # Copyright 2014-2022, John McNamara, jmcnamara@cpan.org # use warnings; use strict; use File::Find; my @includes; # Callback to match header files. sub match_include { push @includes, $File::Find::name if /^.*\.h\z/s; } # Use File::Find to find header files. find({wanted => \&match_include}, 'include/xlsxwriter'); # Sort and remove leading dirs from the include files. @includes = sort @includes; s{^include/xlsxwriter/}{} for @includes; # Generate the unbrella file. print qq{#import \n\n}; print qq{#import "../xlsxwriter.h"\n}; print qq{#import "$_"\n} for @includes; print qq{\n}; print qq{FOUNDATION_EXPORT double xlsxwriterVersionNumber;\n}; print qq{FOUNDATION_EXPORT const unsigned char xlsxwriterVersionString[];\n\n}; libxlsxwriter-RELEASE_1.1.5/dev/release/gen_windows_def_file.pl000066400000000000000000000021401435360132600244730ustar00rootroot00000000000000#!/usr/bin/perl # # Simple program to generate a Windows .def file from the exported symbols in # libxlsxwriter.a. # # perl dev/release/gen_windows_def_file.pl lib/libxlsxwriter.a # # Copyright 2014-2022, John McNamara, jmcnamara@cpan.org # use warnings; use strict; my $lib_file = shift; die "$0: Path to .a lib file required.\n" if !$lib_file; die "$0: File '$lib_file' not found\n" if !-e $lib_file; # Get the symbols from the libxlsxwriter.a file. my @symbols = `nm $lib_file`; my %unique; for my $symbol ( @symbols ) { chomp $symbol; # Get the last field in the row. my @fields = split " ", $symbol; $symbol = $fields[-1]; next unless $symbol; # Skip symbols not belonging to libxlsxwriter. next if $symbol !~ /^_(lxw|work|format|chart|new)/; # Skip some the RedBlack functions. next if $symbol =~ m{RB}; # Strip the leading underscore. $symbol =~ s/^_//; # Remove duplicate instances of some symbols. $unique{$symbol}++; } # Generate the .def file. print "EXPORTS\r\n"; for my $symbol ( sort keys %unique ) { print " ", $symbol, "\r\n"; } libxlsxwriter-RELEASE_1.1.5/dev/release/pkg-config.txt000066400000000000000000000003671435360132600225740ustar00rootroot00000000000000prefix=@PREFIX@ exec_prefix=${prefix} includedir=${prefix}/include libdir=${exec_prefix}/lib Name: libxlsxwriter Description: A C library for creating Excel XLSX files Version: @VERSION@ Cflags: -I${includedir} Libs: -L${libdir} -lxlsxwriter -lz libxlsxwriter-RELEASE_1.1.5/dev/release/release_check.sh000077500000000000000000000157501435360132600231250ustar00rootroot00000000000000#!/bin/bash clear echo "|" echo "| Pre-release checks." echo "|" echo ############################################################# # # Run tests. # function check_test_status { echo echo -n "Are all tests passing? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Run all tests now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please run: make test\n"; exit 1 else echo " Running tests..."; make test check_test_status fi fi } ############################################################# # # Run test for C++ const correctness. # function check_test_const { echo echo -n "Is the const test passing? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Run test now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please run: make test_const\n"; exit 1 else echo " Running test..."; make test_const check_test_const fi fi } ############################################################# # # Run spellcheck. # function check_spellcheck { echo echo -n "Is the spellcheck ok? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Run spellcheck now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please run: make spellcheck\n"; exit 1 else echo " Running spellcheck..."; make spellcheck check_spellcheck fi fi } ############################################################# # # Check Changes file is up to date. # function check_changefile { clear echo "Latest change in Changes file: " perl -ne '$rev++ if /^##/; exit if $rev > 1; print " | $_"' Changes.txt echo echo -n "Is the Changes file updated? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please update the Change file to proceed.\n"; exit 1 fi } ############################################################# # # Check the versions are up to date. # function check_versions { clear echo echo "Latest file versions: " echo awk '/s.version / {print "\t" FILENAME "\t" $1 "\t" $3}' libxlsxwriter.podspec awk '/ LXW/ {print "\t" FILENAME "\t" $2 "\t" $3}' include/xlsxwriter.h echo echo -n "Are the versions up to date? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Update versions? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please update the versions to proceed.\n"; exit 1 else echo " Updating versions..."; perl -i dev/release/update_revison.pl include/xlsxwriter.h libxlsxwriter.podspec check_versions fi fi } ############################################################# # # Check that the docs build cleanly. # function check_docs { # clear echo echo -n "Do the docs build cleanly? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Build docs now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please run: make docs\n"; exit 1 else echo " Building docs..."; make docs check_docs fi fi } ############################################################# # # Generate the cocoapods umbrella file. # function gen_umbrella_file { echo echo -n "Is the umbrella file up to date? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Update umbrella file now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please update cocoapods/libxlsxwriter-umbrella.h\n"; exit 1 else echo " Updating file..."; perl dev/release/gen_umbrella_file.pl > cocoapods/libxlsxwriter-umbrella.h fi fi } ############################################################# # # Check the cocoapods spec file. # function check_pod_spec { echo echo -n "Is the coacoapod file ok? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Run lint now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please run: pod spec lint libxlsxwriter.podspec\n"; exit 1 else echo " Running lint..."; pod spec lint libxlsxwriter.podspec --use-libraries check_pod_spec fi fi } ############################################################# # # Update the pod repo. This can take some time. # function update_pod_repo { echo echo -n "Is the pod repo updated? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo -n " Update now? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please run: pod spec lint libxlsxwriter.podspec\n"; exit 1 else echo " Running update..."; cd ~/.cocoapods/repos/master git pull --ff-only cd - update_pod_repo fi fi } ############################################################# # # Run release checks. # function check_git_status { clear echo "Git status: " git status | awk '{print " | ", $0}' echo "Git log: " git log -1 | awk '{print " | ", $0}' echo "Git latest tag: " git tag -l -n1 | tail -1 | awk '{print " | ", $0}' echo echo -n "Is the git status okay? [y/N]: " read RESPONSE if [ "$RESPONSE" != "y" ]; then echo echo -e "Please fix git status.\n"; echo -e "\ngit add -u"; git tag -l -n1 | tail -1 | perl -lane 'printf "git commit -m \"Prep for release %s\"\ngit tag \"%s\"\n\n", $F[4], $F[0]' | perl dev/release/update_revison.pl exit 1 fi } check_test_status clear check_test_const clear check_spellcheck clear check_docs check_changefile clear gen_umbrella_file check_pod_spec clear update_pod_repo check_versions check_git_status ############################################################# # # All checks complete. # clear echo echo "Everything is configured."; echo echo -n "Confirm release: [y/N]: "; read RESPONSE if [ "$RESPONSE" == "y" ]; then exit 0 else exit 1 fi libxlsxwriter-RELEASE_1.1.5/dev/release/update_revison.pl000066400000000000000000000016201435360132600233640ustar00rootroot00000000000000#!/usr/bin/perl # Simple script to increment x.y.z style version numbers in a file. use strict; use warnings; use Perl::Version; while (<>) { # Increment any x.y.z version strings. if (m/(\d\.\d\.\d)/) { my $version = Perl::Version->new( $1 ); # Components are: revision, version and subversion. if ( $version->version == 9 && $version->subversion == 9 ) { $version->inc_revision(); } elsif ( $version->subversion == 9 ) { $version->inc_version(); } else { $version->inc_subversion(); } my $new_version = $version->stringify(); s/\d\.\d\.\d/$new_version/; } # Increment the LXW_VERSION_ID number in xlsxwriter.h if (m/LXW_VERSION_ID (\d+)/) { my $version = $1; my $new_version = $version + 1; s/\d+/$new_version/; } print; } __END__ libxlsxwriter-RELEASE_1.1.5/docs/000077500000000000000000000000001435360132600165335ustar00rootroot00000000000000libxlsxwriter-RELEASE_1.1.5/docs/Doxyfile000066400000000000000000003333701435360132600202520ustar00rootroot00000000000000# Doxyfile 1.8.20 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = libxlsxwriter # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = NO # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # By default Python docstrings are displayed as preformatted text and doxygen's # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the # doxygen's special commands can be used and the contents of the docstring # documentation blocks is shown as doxygen documentation. # The default value is: YES. PYTHON_DOCSTRING = YES # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. # When you need a literal { or } or , in the value part of an alias you have to # escape them by means of a backslash (\), this can lead to conflicts with the # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files). For instance to make doxygen treat .inc files # as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple # threads. Since this is still an experimental feature the default is set to 1, # which efficively disables parallel processing. Please report any issues you # encounter. Generating dot graphs in parallel is controlled by the # DOT_NUM_THREADS setting. # Minimum value: 0, maximum value: 32, default value: 1. NUM_PROC_THREADS = 1 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # (including Cygwin) and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = NO # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = NO # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = src/mainpage.dox \ src/introduction.dox \ src/getting_started.dox \ src/tutorial01.dox \ src/tutorial02.dox \ src/tutorial03.dox \ ../include/xlsxwriter/workbook.h \ ../include/xlsxwriter/worksheet.h \ ../include/xlsxwriter/format.h \ ../include/xlsxwriter/chart.h \ ../include/xlsxwriter/chartsheet.h \ ../include/xlsxwriter/utility.h \ ../include/xlsxwriter/common.h \ src/working_with_formats.dox \ src/working_with_colors.dox \ src/working_with_formulas.dox \ src/working_with_dates.dox \ src/working_with_charts.dox \ src/working_with_object_position.dox \ src/working_with_autofilters.dox \ src/working_with_data_validation.dox \ src/working_with_conditional_formatting.dox \ src/working_with_tables.dox \ src/working_with_comments.dox \ src/working_with_outlines.dox \ src/working_with_memory.dox \ src/working_with_macros.dox \ src/examples.dox \ src/running_the_tests.dox \ src/faq.dox \ src/bugs.dox \ src/author.dox \ ../License.txt \ ../Changes.txt # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = ../examples \ .. # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = images # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = customdoxygen.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 73 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 65 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 71 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/xcode/), introduced with OSX # 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for # the HTML output. These images will generally look nicer at scaled resolutions. # Possible values are: png (the default) and svg (looks nicer but requires the # pdf2svg or inkscape tool). # The default value is: png. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FORMULA_FORMAT = png # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /