vcl/inc/impgraph.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <vcl/dllapi.h>
  23 #include <vcl/GraphicExternalLink.hxx>
  24 #include <vcl/gdimtf.hxx>
  25 #include <vcl/graph.hxx>
  26 #include "graphic/Manager.hxx"
  27 #include "graphic/GraphicID.hxx"
  28 #include <optional>
  29
  30 struct ImpSwapInfo
  31 {
  32     MapMode     maPrefMapMode;
  33     Size        maPrefSize;
  34     Size        maSizePixel;
  35
  36     bool mbIsAnimated;
  37     bool mbIsEPS;
  38     bool mbIsTransparent;
  39     bool mbIsAlpha;
  40
  41     sal_uInt32 mnAnimationLoopCount;
  42     sal_Int32 mnPageIndex;
  43 };
  44
  45 class OutputDevice;
  46 class GfxLink;
  47 class ImpSwapFile;
  48 class GraphicConversionParameters;
  49 class ImpGraphic;
  50 namespace rtl { class OStringBuffer; }
  51
  52 enum class GraphicContentType : sal_Int32
  53 {
  54     Bitmap,
  55     Animation,
  56     Vector
  57 };
  58
  59 class VCL_DLLPUBLIC ImpGraphic final
  60 {
  61     friend class Graphic;
  62     friend class GraphicID;
  63     friend class vcl::graphic::Manager;
  64
  65 private:
  66
  67     GDIMetaFile                  maMetaFile;
  68     BitmapEx                     maBitmapEx;
  69     /// If maBitmapEx is empty, this preferred size will be set on it when it gets initialized.
  70     Size                         maExPrefSize;
  71     ImpSwapInfo                  maSwapInfo;
  72     std::unique_ptr<Animation>   mpAnimation;
  73     std::shared_ptr<GraphicReader> mpContext;
  74     std::shared_ptr<ImpSwapFile> mpSwapFile;
  75     std::shared_ptr<GfxLink>     mpGfxLink;
  76     GraphicType                  meType;
  77     mutable sal_uLong            mnSizeBytes;
  78     bool                         mbSwapOut;
  79     bool                         mbDummyContext;
  80     std::shared_ptr<VectorGraphicData> maVectorGraphicData;
  81     // cache checksum computation
  82     mutable BitmapChecksum       mnChecksum = 0;
  83
  84     std::optional<GraphicID>     mxGraphicID;
  85     GraphicExternalLink          maGraphicExternalLink;
  86
  87     std::chrono::high_resolution_clock::time_point maLastUsed;
  88     bool mbPrepared;
  89
  90 public:
  91     ImpGraphic();
  92     ImpGraphic( const ImpGraphic& rImpGraphic );
  93     ImpGraphic( ImpGraphic&& rImpGraphic ) noexcept;
  94     ImpGraphic( GraphicExternalLink aExternalLink);
  95     ImpGraphic(std::shared_ptr<GfxLink> xGfxLink, sal_Int32 nPageIndex = 0);
  96     ImpGraphic( const BitmapEx& rBmpEx );
  97     ImpGraphic(const std::shared_ptr<VectorGraphicData>& rVectorGraphicDataPtr);
  98     ImpGraphic( const Animation& rAnimation );
  99     ImpGraphic( const GDIMetaFile& rMtf );
 100     ~ImpGraphic();
 101
 102     void setPrepared(bool bAnimated, const Size* pSizeHint);
 103
 104 private:
 105
 106     ImpGraphic&         operator=( const ImpGraphic& rImpGraphic );
 107     ImpGraphic&         operator=( ImpGraphic&& rImpGraphic );
 108     bool                operator==( const ImpGraphic& rImpGraphic ) const;
 109     bool                operator!=( const ImpGraphic& rImpGraphic ) const { return !( *this == rImpGraphic ); }
 110
 111     OUString const & getOriginURL() const
 112     {
 113         return maGraphicExternalLink.msURL;
 114     }
 115
 116     void setOriginURL(OUString const & rOriginURL)
 117     {
 118         maGraphicExternalLink.msURL = rOriginURL;
 119     }
 120
 121     OString getUniqueID()
 122     {
 123         if (!mxGraphicID)
 124             mxGraphicID.emplace(*this);
 125         return mxGraphicID->getIDString();
 126     }
 127
 128     void createSwapInfo();
 129     void restoreFromSwapInfo();
 130
 131     void                clearGraphics();
 132     void                clear();
 133
 134     GraphicType         getType() const { return meType;}
 135     void                setDefaultType();
 136     bool                isSupportedGraphic() const;
 137
 138     bool                isTransparent() const;
 139     bool                isAlpha() const;
 140     bool                isAnimated() const;
 141     bool                isEPS() const;
 142
 143     bool isAvailable() const;
 144     bool makeAvailable();
 145
 146     Bitmap              getBitmap(const GraphicConversionParameters& rParameters) const;
 147     BitmapEx            getBitmapEx(const GraphicConversionParameters& rParameters) const;
 148     /// Gives direct access to the contained BitmapEx.
 149     const BitmapEx&     getBitmapExRef() const;
 150     Animation           getAnimation() const;
 151     const GDIMetaFile&  getGDIMetaFile() const;
 152
 153     Size                getSizePixel() const;
 154
 155     Size                getPrefSize() const;
 156     void                setPrefSize( const Size& rPrefSize );
 157
 158     MapMode             getPrefMapMode() const;
 159     void                setPrefMapMode( const MapMode& rPrefMapMode );
 160
 161     sal_uLong           getSizeBytes() const;
 162
 163     void                draw(OutputDevice& rOutDev, const Point& rDestPt) const;
 164     void                draw(OutputDevice& rOutDev, const Point& rDestPt,
 165                              const Size& rDestSize) const;
 166
 167     void                startAnimation(OutputDevice& rOutDev,
 168                                        const Point& rDestPt,
 169                                        const Size& rDestSize,
 170                                        tools::Long nRendererId,
 171                                        OutputDevice* pFirstFrameOutDev);
 172     void                stopAnimation( const OutputDevice* pOutputDevice,
 173                                            tools::Long nRendererId );
 174
 175     void                setAnimationNotifyHdl( const Link<Animation*,void>& rLink );
 176     Link<Animation*,void> getAnimationNotifyHdl() const;
 177
 178     sal_uInt32          getAnimationLoopCount() const;
 179
 180 private:
 181     // swapping methods
 182     bool swapInFromStream(SvStream& rStream);
 183     bool swapInGraphic(SvStream& rStream);
 184
 185     bool swapInContent(SvStream& rStream);
 186     bool swapOutContent(SvStream& rStream);
 187     bool swapOutGraphic(SvStream& rStream);
 188     // end swapping
 189
 190     std::shared_ptr<GraphicReader>& getContext() { return mpContext;}
 191     void                setContext( const std::shared_ptr<GraphicReader>& pReader );
 192     void                setDummyContext( bool value ) { mbDummyContext = value; }
 193     bool                isDummyContext() const { return mbDummyContext; }
 194     void                setGfxLink( const std::shared_ptr<GfxLink>& );
 195     const std::shared_ptr<GfxLink> & getSharedGfxLink() const;
 196     GfxLink             getGfxLink() const;
 197     bool                isGfxLink() const;
 198
 199     BitmapChecksum      getChecksum() const;
 200
 201     const std::shared_ptr<VectorGraphicData>& getVectorGraphicData() const;
 202
 203     /// Gets the bitmap replacement for a vector graphic.
 204     BitmapEx getVectorGraphicReplacement() const;
 205
 206     bool ensureAvailable () const;
 207
 208     sal_Int32 getPageNumber() const;
 209
 210     // Set the pref size, but don't force swap-in
 211     void setValuesForPrefSize(const Size& rPrefSize);
 212     // Set the pref map mode, but don't force swap-in
 213     void setValuesForPrefMapMod(const MapMode& rPrefMapMode);
 214
 215 public:
 216     void resetChecksum() { mnChecksum = 0; }
 217     bool swapIn();
 218     bool swapOut();
 219     bool isSwappedOut() const { return mbSwapOut; }
 220     SvStream* getSwapFileStream() const;
 221     // public only because of use in GraphicFilter
 222     void updateFromLoadedGraphic(const ImpGraphic* graphic);
 223     void dumpState(rtl::OStringBuffer &rState);
 224 };
 225
 226 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */