README.md

   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 LibreOffice is an integrated office suite based on copyleft licenses
   5 and compatible with most document formats and standards. Libreoffice
   6 is backed by The Document Foundation, which represents a large
   7 independent community of enterprises, developers and other volunteers
   8 moved by the common goal of bringing to the market the best software
   9 for personal productivity. LibreOffice is open source, and free to
  10 download, use and distribute.
  11
  12 A quick overview of the LibreOffice code structure.
  13
  14 ## Overview
  15
  16 You can develop for LibreOffice in one of two ways, one
  17 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 for which you can read the API docs [here](https://api.libreoffice.org/)
  20 and [here](https://wiki.openoffice.org/wiki/Documentation/DevGuide).
  21 This re-uses the (extremely generic) UNO APIs that are also used by
  22 macro scripting in StarBasic.
  23
  24 The best way to add a generally useful feature to LibreOffice
  25 is to work on the code base however. Overall this way makes it easier
  26 to compile and build your code, it avoids any arbitrary limitations of
  27 our scripting APIs, and in general is far more simple and intuitive -
  28 if you are a reasonably able C++ programmer.
  29
  30 ## The build chain and runtime baselines
  31
  32 These are the current minimal operating system and compiler versions to
  33 run and compile LibreOffice, also used by the TDF builds:
  34
  35 * Windows:
  36     * Runtime: Windows 7
  37     * Build: Cygwin + Visual Studio 2017 version 15.7
  38 * macOS:
  39     * Runtime: 10.10
  40     * Build: 10.13.2 + Xcode 9.3
  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
  44 * iOS (only for LibreOfficeKit):
  45     * Runtime: 11.4 (only support for newer i devices == 64 bit)
  46     * Build: Xcode 9.3 and iPhone SDK 11.4
  47 * Android:
  48     * Build: NDK r19c
  49
  50 If you want to use Clang with the LibreOffice compiler plugins, the minimal
  51 version of Clang is 5.0.2. Since Xcode doesn't provide the compiler plugin
  52 headers, you have to compile your own Clang to use them on macOS.
  53
  54 You can find the TDF configure switches in the distro-configs/ directory.
  55
  56 To setup your initial build environment on Windows and macOS, we provide
  57 the LibreOffice Development Environment
  58 ([LODE](https://wiki.documentfoundation.org/Development/lode)) scripts.
  59
  60 For more information see the build instructions for your platform in the
  61 [TDF wiki](https://wiki.documentfoundation.org/Development).
  62
  63 ## The important bits of code
  64
  65 Each module should have a `README` file inside it which has some
  66 degree of documentation for that module; patches are most welcome to
  67 improve those. We have those turned into a web page here:
  68
  69 https://docs.libreoffice.org/
  70
  71 However, there are two hundred modules, many of them of only
  72 peripheral interest for a specialist audience. So - where is the
  73 good stuff, the code that is most useful. Here is a quick overview of
  74 the most important ones:
  75
  76 Module    | Description
  77 ----------|-------------------------------------------------
  78 sal/      | this provides a simple System Abstraction Layer
  79 tools/    | this provides basic internal types: 'Rectangle', 'Color' etc.
  80 vcl/      | this is the widget toolkit library and one rendering abstraction
  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
  82 sfx2/     | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
  83 svx/      | drawing model related helper code, including much of Draw/Impress
  84
  85 Then applications
  86
  87 Module    | Description
  88 ----------|-------------------------------------------------
  89 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
  90 sw/       | Writer
  91 sc/       | Calc
  92 sd/       | Draw / Impress
  93
  94 There are several other libraries that are helpful from a graphical perspective:
  95
  96 Module    | Description
  97 ----------|-------------------------------------------------
  98 basegfx/  | algorithms and data-types for graphics as used in the canvas
  99 canvas/   | new (UNO) canvas rendering model with various backends
 100 cppcanvas/ | C++ helper classes for using the UNO canvas
 101 drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily.
 102
 103 ## Rules for #include directives (C/C++)
 104
 105 Use the `"..."` form if and only if the included file is found next to the
 106 including file. Otherwise, use the `<...>` form. (For further details, see the
 107 mail [Re: C[++]: Normalizing include syntax ("" vs
 108 <>)](https://lists.freedesktop.org/archives/libreoffice/2017-November/078778.html).)
 109
 110 The UNO API include files should consistently use double quotes, for the
 111 benefit of external users of this API.
 112
 113 loplugin:includeform (compilerplugins/clang/includeform.cxx) enforces these rules.
 114
 115
 116 ## Finding out more
 117
 118 Beyond this, you can read the `README` files, send us patches, ask
 119 on the mailing list libreoffice@lists.freedesktop.org (no subscription
 120 required) or poke people on IRC `#libreoffice-dev` on irc.freenode.net -
 121 we're a friendly and generally helpful mob. We know the code can be
 122 hard to get into at first, and so there are no silly questions.