diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /slideshow/manifest.txt | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | slideshow/manifest.txt | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/slideshow/manifest.txt b/slideshow/manifest.txt new file mode 100644 index 000000000..2750be66a --- /dev/null +++ b/slideshow/manifest.txt @@ -0,0 +1,103 @@ +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# This file incorporates work covered by the following license notice: +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed +# with this work for additional information regarding copyright +# ownership. The ASF licenses this file to you under the Apache +# License, Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain a copy of +# the License at http://www.apache.org/licenses/LICENSE-2.0 . +# + +Slideshow module design & coding manifest +========================================= + +Coding style: +------------- + + - modified BSD style: + if( !test ) + { + function( arg1, + arg2, + arg3 ); + } + + - members are always named maSomething + + - no tabs, indent four spaces + + - Class names (and type names in general) are UpperCamelCase, method + names lowerCamelCase + + - all file names are lowercase, header files end in hxx, source files + in cxx; one header per class, only one linkable class per cxx. + + - header guards follow this scheme: INCLUDED_SLIDESHOW_<CLASSNAME>_HXX + + - module-external headers, and system headers are included like this: + #include <module/header.hxx>. + module-internal headers are included like this: + #include "header.hxx" + No external header guards are used in cxx files + + +Design +------ + + - currently, the slideshow module is basically + single-threaded. Therefore, the XSlideShow interface must be called + from the _main thread_ (this precondition is asserted). Other + listener interfaces, which we could not impose this limitation upon + (XSlideShowView's XMouseMotionListener, XMouseListener, + XPaintListener and XModifyListener) will queue the events, and + process them in the main thread. Therefore, XSlideShow::update() + needs to be called frequently from the slideshow client. + + This design is necessitated by the fact that at least one XCanvas + implementation (vclcanvas) must be called from the main thread + only. Once the UNO threading framework is integrated, this can be + changed. + + As of now, SlideView, SlideShowImpl, EventMultiplexerListener and + DummyRenderer are exposed to calls from the outside world; of + those, SlideView and EventMultiplexerListener serialize the calls + by enqueuing events, SlideShowImpl imposes the hard constraint of + being called from the main thread, and DummyRenderer is content + with a simple object mutex. As a side effect, the global EventQueue + must be thread-safe (as one of the few internal objects having an + object mutex) + + - wherever possible, abstract interfaces and shared_ptr are used. + * exception: global objects like EventQueue, + and tightly collaborating classes, like Slide/LayerManager/Layer + + - since shared_ptr can lead to circular references (resulting in + memory leaks), some care needs to be taken to avoid those. Where + circular references are inevitable, or can happen by accident, + classes implement the Disposable interface. The owner of the object + then calls dispose() on its owned objects. + Another way of avoiding circular references are weak_ptr, which are + used in a few places. + One of those places are the ViewEventHandlers, which are held weak + on the EventMultiplexer. Otherwise, every class in need of view + events would have to delegate listening to a dedicated child + object, or burden their clients with the Disposable interface. + + - Pattern: Separate Listener + To avoid circular shared_ptr references, classes in need to + register a listener at EventMultiplexer often implement the + corresponding listener interface in a separate object. This object + is held via shared_ptr by the original class, and normally + registered at the EventMultiplexer (and thus held by shared_ptr + there, too). The separate listener object in turn holds the + original object by plain reference. This is safe, if the original + object removes the listener from the EventMultiplexer, before or + within the destructor. |