xlnt/README.md

Introduction

xlnt is a C++14 library for reading, writing, and modifying XLSX files as described in ECMA 376 4th edition. The API is based on openpyxl, a Python library to read/write Excel 2007 xlsx/xlsm files, and ultimately on PHPExcel, pure PHP library for reading and writing spreadsheet files upon which openpyxl was based. This project is still very much a work in progress, but the core development work is complete.

Usage

Including xlnt in your project

// with -std=c++14 -Ixlnt/include -Lxlnt/lib -lxlnt
// can also use the generated "xlnt.pc" in ./build directory with pkg-config to get these flags
#include <xlnt/xlnt.hpp>

Creating a new spreadsheet and saving it as book1.xlsx

xlnt::workbook wb;
xlnt::worksheet ws = wb.get_active_sheet();
ws.get_cell("A1").set_value(5);
ws.get_cell("B2").set_value("string data");
ws.get_cell("C3").set_formula("=RAND()");
ws.merge_cells("C3:C4");
ws.freeze_panes("B2");
wb.save("book1.xlsx");

Opening an existing spreadsheet, book2.xlsx, and printing all cells

xlnt::workbook wb2;
wb2.load("book2.xlsx");

// no need to use references, "cell", "range", and "worksheet" classes are only wrappers around pointers to memory in the workbook
for(auto row : wb2["sheet2"].rows())
{
    for(auto cell : row)
    {
        std::cout << cell << std::endl;
    }
}

Building

xlnt uses continous integration and passes all 200+ tests in GCC 4.9, GCC5, VS2015, and Clang (using Apple LLVM 7.0).

Build configurations for Visual Studio 2015, GNU Make, and Xcode can be created using cmake and the cmake scripts in the project's cmake directory. A full list of cmake generators can be found here. A basic build would look like (starting in the root xlnt directory):

mkdir build
cd build
cmake ..
make -j8

The resulting library, libxlnt.dylib or libxlnt.so or xlnt.dll, would be found in the build/lib directory. Other cmake configuration options can be found using "cmake -LH". These options include shared vs static library and whether to build tests or not. An example of building a static library with tests as an Xcode project:

mkdir build
cd build
cmake -D WITH_TESTS=1 -D SHARED=0 -D STATIC=1 -G Xcode ..
cmake --build .
bin/xlnt.test

Dependencies

xlnt uses the following libraries, which are included in the source tree (all but miniz as git submodules) for convenience:

• miniz v1.15_r4 (public domain/unlicense)
• libstudxml v1.1.0 (MIT license)
• utfcpp v2.3.4 (Boost Software License, Version 1.0)
• cxxtest v4.4 (LGPLv3 license [only used for testing, separate from main library assembly])
• pugixml v1.7 (LGPLv3 license [only used for testing, separate from main library assembly])
• botan v1.11 (BSD license [only used for reading/writing password-protected workbooks, WITH_CRYPTO=1])
• pole v0.5 (BSD license [only used for reading/writing password-protected workbooks, WITH_CRYPTO=1])

Initialize the submodules with this command:

git submodule update --init

Documentation

More detailed documentation with examples can be found on Read The Docs (warning: this is somewhat out of date at the moment).

License

xlnt is currently released to the public for free under the terms of the MIT License:

Copyright (c) 2015-2016 Thomas Fussell

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.