tdf#159549 sw: fix ODF import of newly colliding Body Text styles

Commit c83d241effbd09491e9f96d3e435ab91700f58b0 "tdf#154933 Rename "Text
Body" para style to "Body Text"" introduced a regression when importing
certain ODF documents, but the problem is actually pre-existing.

What happens is that first the built-in "Text body" style is created,
and then a non-built-in style with the same translated name as "Text
body" is imported, and instead of creating a new style, the built-in one
is found and used, and so its properties are overwritten.

The root cause is that SwStyleNameMapper::FillProgName() and in
particular SwStyleNameMapper::FillUIName() are defined poorly, ever
since they were introduced in 2001 in commit
4fbc9dd48b7cebb304010e7337b1bbc3936c7923

It becomes obvious relatively quickly that the way style names work is
that at the UNO API level, the "ProgName" (internal, non-localised)
names are used, and at the core document level, the "UIName" (localised)
names are used.

This is in itself questionable - why is the translation from ProgName to
UIName not done in the UI? - but also very expensive to change now.

So then the UNO services are responsible for translating between
ProgName and UIName.

But the 2 functions don't do that properly; both need to check if the
given name is a known ProgName *or* a known UIName, and rename it in
case it collides with a known target name; also the 2 functions need to
cancel each other out, not add " (user)" at the end in both directions.

Fixing this causes numerous tests to fail, due to:

1. the UNO services calling themselves with already converted style
   names, which are then translated a second time, which fails now.
   (or calling the wrong function like SwXStyleFamily::getByIndex())

2. many tests call the UNO API with UINames instead of ProgNames

3. somehow the writerfilter import is also changed, causing failures in
   e.g. testTdf113182 and testTdf104492

4. buggy code elsewhere (lcl_getUsedPageStyles()), problem similar to
   1., for PageDescs

5. potentially more buggy code yet to be discovered (definitely table
   styles, forgot which test that was)

So limit this fix for now to only paragraph styles, and don't do it in
writerfilter import, now at least sw.check passes.

Reviewed-on: https://gerrit.libreoffice.org/c/core/+/177858
Reviewed-by: Thorsten Behrens <thorsten.behrens@allotropia.de>
Tested-by: Jenkins
(cherry picked from commit bd727654ec8cc339292072b42073e57d566cc220)

tdf#159549 sw: fix style name in SwXStyle::getParentStyle()

For a style that isn't inserted yet, the m_sParentStyleName is converted
to UIName by setParentStyle() but isn't converted back to ProgName in
getParentStyle().

This caused all of the writerfilter test failures in commit
bd727654ec8cc339292072b42073e57d566cc220.

Reviewed-on: https://gerrit.libreoffice.org/c/core/+/177998
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
(cherry picked from commit 2b8d794e448a7d3c573ff79cffe9decc8d960262)

tdf#159549 sw: add unit test

Reviewed-on: https://gerrit.libreoffice.org/c/core/+/178148
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Tested-by: Jenkins
(cherry picked from commit bfdba3c86301e9680204de0a66bfbfc6383494b9)

Change-Id: I5cbdf3e174622e83f9af8787c3671b88c0e37bac
9 files changed
tree: bddae6e9f0a1d14cfae54344bf5e6143f14d4453
  1. .git-hooks/
  2. .github/
  3. .vscode/
  4. accessibility/
  5. android/
  6. animations/
  7. apple_remote/
  8. avmedia/
  9. basctl/
  10. basegfx/
  11. basic/
  12. bean/
  13. bin/
  14. binaryurp/
  15. bridges/
  16. canvas/
  17. chart2/
  18. cli_ure/
  19. codemaker/
  20. comphelper/
  21. compilerplugins/
  22. config_host/
  23. configmgr/
  24. connectivity/
  25. cppcanvas/
  26. cppu/
  27. cppuhelper/
  28. cpputools/
  29. cui/
  30. dbaccess/
  31. desktop/
  32. distro-configs/
  33. docmodel/
  34. drawinglayer/
  35. editeng/
  36. embeddedobj/
  37. embedserv/
  38. emfio/
  39. eventattacher/
  40. extensions/
  41. external/
  42. extras/
  43. filter/
  44. forms/
  45. formula/
  46. fpicker/
  47. framework/
  48. helpcompiler/
  49. hwpfilter/
  50. i18nlangtag/
  51. i18npool/
  52. i18nutil/
  53. icon-themes/
  54. idl/
  55. idlc/
  56. include/
  57. instsetoo_native/
  58. io/
  59. ios/
  60. javaunohelper/
  61. jurt/
  62. jvmaccess/
  63. jvmfwk/
  64. l10ntools/
  65. librelogo/
  66. libreofficekit/
  67. lingucomponent/
  68. linguistic/
  69. lotuswordpro/
  70. m4/
  71. msicreator/
  72. nlpsolver/
  73. o3tl/
  74. odk/
  75. offapi/
  76. officecfg/
  77. onlineupdate/
  78. oovbaapi/
  79. oox/
  80. opencl/
  81. osx/
  82. package/
  83. pch/
  84. postprocess/
  85. pyuno/
  86. qadevOOo/
  87. readlicense_oo/
  88. registry/
  89. remotebridges/
  90. reportbuilder/
  91. reportdesign/
  92. ridljar/
  93. sal/
  94. salhelper/
  95. sax/
  96. sc/
  97. scaddins/
  98. sccomp/
  99. schema/
  100. scp2/
  101. scripting/
  102. sd/
  103. sdext/
  104. setup_native/
  105. sfx2/
  106. shell/
  107. slideshow/
  108. smoketest/
  109. solenv/
  110. soltools/
  111. sot/
  112. starmath/
  113. static/
  114. stoc/
  115. store/
  116. svgio/
  117. svl/
  118. svtools/
  119. svx/
  120. sw/
  121. swext/
  122. sysui/
  123. test/
  124. testtools/
  125. toolkit/
  126. tools/
  127. ucb/
  128. ucbhelper/
  129. udkapi/
  130. uitest/
  131. UnoControls/
  132. unodevtools/
  133. unoidl/
  134. unoil/
  135. unotest/
  136. unotools/
  137. unoxml/
  138. ure/
  139. uui/
  140. vbahelper/
  141. vcl/
  142. winaccessibility/
  143. wizards/
  144. writerfilter/
  145. writerperfect/
  146. xmerge/
  147. xmlhelp/
  148. xmloff/
  149. xmlreader/
  150. xmlscript/
  151. xmlsecurity/
  152. .buckconfig
  153. .buckversion
  154. .clang-format
  155. .editorconfig
  156. .git-blame-ignore-revs
  157. .gitattributes
  158. .gitignore
  159. .gitmodules
  160. .gitpod.dockerfile
  161. .gitpod.yml
  162. .gitreview
  163. antivirusDetection.vbs
  164. autogen.sh
  165. BUCK
  166. config.guess
  167. config.sub
  168. config_host.mk.in
  169. config_host_lang.mk.in
  170. configure.ac
  171. COPYING
  172. COPYING.LGPL
  173. COPYING.MPL
  174. cpp.hint
  175. download.lst
  176. g
  177. install-sh
  178. install_deps.sh
  179. leak-suppress.txt
  180. Library_merged.mk
  181. logerrit
  182. Makefile.fetch
  183. Makefile.gbuild
  184. Makefile.in
  185. README.cross
  186. README.help.md
  187. README.md
  188. README.Solaris
  189. Repository.mk
  190. RepositoryExternal.mk
  191. RepositoryFixes.mk
  192. RepositoryModule_build.mk
  193. RepositoryModule_host.mk
  194. sanitize-ubsan-excludelist
  195. setup.cfg
  196. TEMPLATE.SOURCECODE.HEADER
  197. tsan-suppress.txt
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 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.15
    • Build: 12 (13 for aarch64) + Xcode 14
  • Linux:
    • Runtime: RHEL 8 or CentOS 8 and comparable
    • Build: either GCC 12; or Clang 12 with libstdc++ 8.5
  • 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 r23 and SDK 30.0.3
  • 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 17 or later.

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:

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:

ModuleDescription
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

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

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