Stephan Bergmann
3db6a93c55
...as is used by e.g. Writer's "View - Toolbars - Form Controls", then Ctrl+click the "Text Box" icon: Afterebd7cc1848"tdf#150845: sw_uiwriter3: Add unittest", my 2560x1600 screen Windows laptop kept failing CppunitTest_sw_uiwriter3 with > sw/qa/extras/uiwriter/uiwriter3.cxx:962:testTdf150845::TestBody > equality assertion failed > - Expected: 1 > - Actual : 0 As it turned out, SwDrawBase::GetDefaultCenterPos happened to pick a position that didn't fall on the single page horizontally centered in the Writer window, but on the background surrounding it, so in SwFEShell::BeginCreate (sw/source/core/frmedt/feshview.cxx) > if ( GetPageNumber( rPos ) ) failed and no control was created (and so the number of shapes expected by the test wasn't matched). The logic to adjust aCenter based on aDocSz is there ever since39ed6bd497"#104503# put inserted control at a central position", but that's hard to understand for me because it's hard to understand for me how SwRootFrame::CheckViewLayout in sw/source/core/layout/pagechg.cxx computes aNewSize (which is what ends up here as aDocSz): At least when the Writer window width is larger than necessary to show the full page, aDocSz.Width() apparently doesn't only measure the page's width, but also (part of?) the width of the surrounding background on its left, so the aCenter.setX(...) adjustment could have come up with an X coordinate that wasn't actually centered on the page as apparently expected by the original code. Experimentally, I learned that for the three Writer view modes: * "Single-page view" corresponds to GetViewLayoutColumns() == 1 and displays the page horizontally centered in the window. * "Multiple-page view" corresponds to GetViewLayoutColumns() == 0 and displays the pages starting flush left in the window. * "Book view" corresponds to GetViewLayoutColumns() == 2 and displays the two pages horizontally centered in the window. And at least when the window width is substantially larger than necessary to show the one full page of a one-page document (as when showing a default full-size Writer window on my 2560x1600 screen Windows laptop), the behavior of inserting a default-positioned Ctrl+click "Text Box" icon is: * For "Single-page view" it now actually inserts the control, horizontally centered on the page (instead of not inserting it at all, or inserting it not horizontally centered). * For "Multiple-page view" it keeps inserting the control horizontally centered on the page, as before. * For "Book view" it keeps not inserting the control, as before, as apparently before and after it happens to compute positions (albeit different ones) that fall on the background. Change-Id: Icf7dd30d4ce81e9d47a3c362f455f721f9e3dd30 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/140334 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
LibreOffice
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 and Developers Guide. 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.10
- macOS:
- Runtime: 10.14
- Build: 11.0 + Xcode 12.5
- Linux:
- Runtime: RHEL 7 or CentOS 7
- Build: either GCC 7.0.0; or Clang 8.0.1 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
- Emscripten / WASM:
- Runtime: a browser with SharedMemory support (threads + atomics)
- Build: Qt 5.15 with Qt supported Emscripten 1.39.8
- See README.wasm
Java is required for building many parts of LibreOffice. In TDF Wiki article Development/Java, the exact modules that depend on Java are listed.
The baseline for Java is Java Development Kit (JDK) Version 11 or later. It is possible to build LibreOffice with JDK version 9, but it is no longer supported by the JDK vendors, thus it should be avoided.
If you want to use Clang with the LibreOffice compiler plugins, the minimal version of Clang is 12.0.1. 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.md 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:
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.md 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.libera.chat -
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.