README.md 5.43 KB
Newer Older
1
# LibreOffice
2
[![Coverity Scan Build Status](https://scan.coverity.com/projects/211/badge.svg)](https://scan.coverity.com/projects/211) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/307/badge)](https://bestpractices.coreinfrastructure.org/projects/307)
3

4 5 6 7 8 9 10 11
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.

12 13 14 15 16 17
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
18
way: it is possible to use the SDK to develop an extension,
19 20
for which you can read the API docs [here](https://api.libreoffice.org/)
and [here](https://wiki.openoffice.org/wiki/Documentation/DevGuide).
21 22
This re-uses the (extremely generic) UNO APIs that are also used by
macro scripting in StarBasic.
23 24 25 26 27 28 29

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.

Jan-Marek Glogowski's avatar
Jan-Marek Glogowski committed
30 31 32 33 34 35
## 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:
36
    * Runtime: Windows 7
Tor Lillqvist's avatar
Tor Lillqvist committed
37
    * Build: Cygwin + Visual Studio 2017
Jan-Marek Glogowski's avatar
Jan-Marek Glogowski committed
38
* macOS:
39
    * Runtime: 10.10
40
    * Build: 10.13.2 + Xcode 9.3
Jan-Marek Glogowski's avatar
Jan-Marek Glogowski committed
41
* Linux:
42
    * Runtime: RHEL 7 or CentOS 7
43
    * Build: either GCC 7.0.0; or Clang 5.0.2 with libstdc++ 7.3.0
jan Iversen's avatar
jan Iversen committed
44
* iOS (only for LibreOfficeKit):
45 46
    * Runtime: 11.4 (only support for newer i devices == 64 bit)
    * Build: Xcode 9.3 and iPhone SDK 11.4
Jan-Marek Glogowski's avatar
Jan-Marek Glogowski committed
47 48

If you want to use Clang with the LibreOffice compiler plugins, the minimal
49
version of Clang is 5.0.2. Since Xcode doesn't provide the compiler plugin
Jan-Marek Glogowski's avatar
Jan-Marek Glogowski committed
50 51 52 53 54 55 56 57 58 59
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](https://wiki.documentfoundation.org/Development/lode)) scripts.

For more information see the build instructions for your platform in the
[TDF wiki](https://wiki.documentfoundation.org/Development).
60 61 62 63 64 65 66

## 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:

67
https://docs.libreoffice.org/
68 69 70 71 72 73 74 75 76 77 78

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
79 80 81
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
82 83 84 85 86 87

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
88 89 90
sw/       | Writer
sc/       | Calc
sd/       | Draw / Impress
91 92 93 94 95 96 97 98

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
99
drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily.
100

101 102 103 104 105 106 107 108 109 110
## 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
<>)](https://lists.freedesktop.org/archives/libreoffice/2017-November/078778.html).)

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

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

113 114 115 116 117 118 119 120

## 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.