Skip to content
Read-only LibreOffice core repo - no pull request (use gerrit instead https://gerrit.libreoffice.org/) - don't download zip, use https://dev-www.libreoffice.org/bundles/ instead
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.git-hooks
.github
UnoControls
accessibility
android
animations
apple_remote
avmedia
basctl
basegfx
basic
bean
bin
binaryurp
bridges
canvas
chart2
cli_ure
codemaker
comphelper
compilerplugins
config_host
configmgr
connectivity
cppcanvas
cppu
cppuhelper
cpputools
cui
dbaccess
desktop
dictionaries @ 74d8e82
distro-configs
drawinglayer
dtrans
editeng
embeddedobj
embedserv
emfio
eventattacher
extensions
external
extras
filter
forms
formula
fpicker
framework
helpcompiler
helpcontent2 @ 2748a45
hwpfilter
i18nlangtag
i18npool
i18nutil
icon-themes
idl
idlc
include
instsetoo_native
io
ios
javaunohelper
jurt
jvmaccess
jvmfwk
l10ntools
librelogo
libreofficekit
lingucomponent
linguistic
lotuswordpro
m4
nlpsolver
o3tl
odk
offapi
officecfg
onlineupdate
oovbaapi
oox
opencl
osx
package
pch
postprocess
pyuno
qadevOOo
readlicense_oo
registry
remotebridges
reportbuilder
reportdesign
ridljar
sal
salhelper
sax
sc
scaddins
sccomp
schema
scp2
scripting
sd
sdext
setup_native
sfx2
shell
slideshow
smoketest
solenv
soltools
sot
starmath
stoc
store
svgio
svl
svtools
svx
sw
swext
sysui
test
testtools
toolkit
tools
translations @ 0a73e51
ucb
ucbhelper
udkapi
uitest
unodevtools
unoidl
unoil
unotest
unotools
unoxml
ure
uui
vbahelper
vcl
winaccessibility
wizards
writerfilter
writerperfect
xmerge
xmlhelp
xmloff
xmlreader
xmlscript
xmlsecurity
.buckconfig
.buckversion
.clang-format
.editorconfig
.git-blame-ignore-revs
.gitattributes
.gitignore
.gitmodules
.gitpod.dockerfile
.gitpod.yml
.gitreview
BUCK
COPYING
COPYING.LGPL
COPYING.MPL
Library_merged.mk
Makefile.fetch
Makefile.gbuild
Makefile.in
README.Solaris
README.cross
README.md
Repository.mk
RepositoryExternal.mk
RepositoryFixes.mk
RepositoryModule_build.mk
RepositoryModule_host.mk
TEMPLATE.SOURCECODE.HEADER
antivirusDetection.vbs
autogen.sh
config.guess
config.sub
config_host.mk.in
config_host_lang.mk.in
configure.ac
download.lst
g
hardened_runtime.xcent
install-sh
leak-suppress.txt
lo.xcent
logerrit
sanitize-ubsan-blacklist
setup.cfg

README.md

LibreOffice

Coverity Scan Build Status CII Best Practices Translation status

LibreOffice is an integrated office suite based on copyleft licenses and compatible with most document formats and standards. Libreoffice is backed by The Document Foundation, which represents a large independent community of enterprises, developers and other volunteers moved by the common goal of bringing to the market the best software for personal productivity. LibreOffice is open source, and free to download, use and distribute.

A quick overview of the LibreOffice code structure.

Overview

You can develop for LibreOffice in one of two ways, one recommended and one much less so. First the somewhat less recommended way: it is possible to use the SDK to develop an extension, for which you can read the API docs here and here. This re-uses the (extremely generic) UNO APIs that are also used by macro scripting in StarBasic.

The best way to add a generally useful feature to LibreOffice is to work on the code base however. Overall this way makes it easier to compile and build your code, it avoids any arbitrary limitations of our scripting APIs, and in general is far more simple and intuitive - if you are a reasonably able C++ programmer.

The build chain and runtime baselines

These are the current minimal operating system and compiler versions to run and compile LibreOffice, also used by the TDF builds:

  • Windows:
    • Runtime: Windows 7
    • Build: Cygwin + Visual Studio 2019 version 16.4
  • macOS:
    • Runtime: 10.10
    • Build: 10.14.4 + Xcode 11.3
  • Linux:
    • Runtime: RHEL 7 or CentOS 7
    • Build: either GCC 7.0.0; or Clang 5.0.2 with libstdc++ 7.3.0
  • iOS (only for LibreOfficeKit):
    • Runtime: 11.4 (only support for newer i devices == 64 bit)
    • Build: Xcode 9.3 and iPhone SDK 11.4
  • Android:
    • Build: NDK r19c and SDK 22.6.2

If you want to use Clang with the LibreOffice compiler plugins, the minimal version of Clang is 5.0.2. Since Xcode doesn't provide the compiler plugin headers, you have to compile your own Clang to use them on macOS.

You can find the TDF configure switches in the distro-configs/ directory.

To setup your initial build environment on Windows and macOS, we provide the LibreOffice Development Environment (LODE) scripts.

For more information see the build instructions for your platform in the TDF wiki.

The important bits of code

Each module should have a README file inside it which has some degree of documentation for that module; patches are most welcome to improve those. We have those turned into a web page here:

https://docs.libreoffice.org/

However, there are two hundred modules, many of them of only peripheral interest for a specialist audience. So - where is the good stuff, the code that is most useful. Here is a quick overview of the most important ones:

Module Description
sal/ this provides a simple System Abstraction Layer
tools/ this provides basic internal types: 'Rectangle', 'Color' etc.
vcl/ this is the widget toolkit library and one rendering abstraction
framework UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from /uiconfig/ files
sfx2/ legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
svx/ drawing model related helper code, including much of Draw/Impress

Then applications

Module Description
desktop/ this is where the 'main' for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop
sw/ Writer
sc/ Calc
sd/ Draw / Impress

There are several other libraries that are helpful from a graphical perspective:

Module Description
basegfx/ algorithms and data-types for graphics as used in the canvas
canvas/ new (UNO) canvas rendering model with various backends
cppcanvas/ C++ helper classes for using the UNO canvas
drawinglayer/ View code to render drawable objects and break them down into primitives we can render more easily.

Rules for #include directives (C/C++)

Use the "..." form if and only if the included file is found next to the including file. Otherwise, use the <...> form. (For further details, see the mail Re: C[++]: Normalizing include syntax ("" vs <>).)

The UNO API include files should consistently use double quotes, for the benefit of external users of this API.

loplugin:includeform (compilerplugins/clang/includeform.cxx) enforces these rules.

Finding out more

Beyond this, you can read the README files, send us patches, ask on the mailing list libreoffice@lists.freedesktop.org (no subscription required) or poke people on IRC #libreoffice-dev on irc.freenode.net - we're a friendly and generally helpful mob. We know the code can be hard to get into at first, and so there are no silly questions.

You can’t perform that action at this time.