Macro Open Source Project: LOK

This is a public project that forks LibreOffice to provide functionality and fixes that don't fit in the upstream project.

This repository is open sourced under the Mozilla Public License 2.0.

This project is not a part of the official LibreOffice project, nor endorsed by the Document Foundation.

Prerequisites

Windows

• Install Visual Studio 2019 Community Edition

  • Select the Windows Development with C++ workload
  • Add the following Individual Components:
    • .NET Framework 4.8 SDK
    • Windows Universal C Runtime

• Install cygwin with MSVC make and nasm using PowerShell:

  [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  
  Invoke-WebRequest https://cygwin.com/setup-x86_64.exe -OutFile C:\setup.exe
  & C:\setup.exe -BNqdDLXgnO -s http://mirrors.kernel.org/sourceware/cygwin/ -l C:\cygwin-packages -R C:\cygwin -P autoconf,automake,bison,cabextract,doxygen,flex,gettext-devel,gnupg,gperf,libxml2-devel,libpng12-devel,make,mintty,openssh,openssl,patch,perl,pkg-config,readline,rsync,unzip,wget,zip,perl-Archive-Zip,perl-Font-TTF,perl-IO-String,python,python3
  
  Invoke-WebRequest https://dev-www.libreoffice.org/bin/cygwin/make-4.2.1-msvc.exe -OutFile C:\cygwin\usr\local\bin\make.exe
  Invoke-WebRequest https://www.nasm.us/pub/nasm/releasebuilds/2.11.06/win32/nasm-2.11.06-win32.zip -OutFile C:\cygwin\nasm.zip
  Expand-Archive -LiteralPath C:\cygwin\nasm.zip -DestinationPath C:\cygwin
  Move-Item -Path C:\cygwin\nasm-2.11.06\nasm.exe -Destination C:\cygwin\usr\local\bin\nasm.exe

• Add C:\cygwin\vs-cygwin.bat containing:

  @echo off
  setlocal enableextensions
  set TERM==
  set ORIGIN=%CD%
  call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" x64
  cd /d %~dp0
  .\bin\bash.exe --login -i -c "cd \"$ORIGIN\"; CHERE_INVOKING=1 exec bash --login -i"
  

• Create a shortcut to vc-cygwin.bat called and change the Start in: location to libreofficekit\libreoffice-core

  For all development purposes, use this shortcut, otherwise things won't work as expected

Linux

• Install dependencies using apt:

  sudo apt-get install git build-essential zip nasm python3 python3-dev \
    autoconf gperf xsltproc libxml2-utils libxrandr-dev libx11-dev bison \
    flex libgtk-3-dev libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev \
    libavahi-client-dev libxt-dev

macOS

• Download and install Xcode 13.4.1. Note that you should have two versions of Xcode, and the 13.4.1 version should be named Xcode13.4.1 (according to the DEVELOPER_DIR env variable)

  # Accept the Xcode license:
  sudo xcodebuild -license accept
  # Always the DEVELOPER_DIR before building
  export DEVELOPER_DIR=/Applications/Xcode13.4.1.app/Contents/Developer

• Install MacPorts

• Install dependencies using MacPorts:

  sudo port install nasm autoconf automake gperf gpatch flex bison gmake gettext

Before running any build commands, you may have to adjust your path to prefer the port-installed versions (such as make): export PATH=/opt/local/libexec/gnubin:/opt/local/bin:/opt/local/sbin:$PATH

Building

You must be in the libreoffce-core subdirectory, otherwise things won't work:

cd libreoffice-core

Windows

./autogen.sh --with-distro=LOKit-Win64
make solenv Module_zlib Module_libpng Module_freetype Module_expat Module_fontconfig Module_cairo Module_icu Module_openssl Module_libffi Module_python3 Module_boost && make Module_nss || make Module_nss && make

After making changes, you can just use make

Linux

./autogen.sh --with-distro=LOKit-Linux
make

After making changes, you can just use make

Mac

./autogen.sh --with-distro=LOKit-Mac
make

After making changes, you can just use make

The result will be in instdir

Documentation

The LibreOffice Developers Guide is a very good resource for understanding the LibreOffice SDK.