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
  29 struct ImpSwapInfo
  30 {
  31     MapMode     maPrefMapMode;
  32     Size        maPrefSize;
  33     Size        maSizePixel;
  34
  35     bool mbIsAnimated;
  36     bool mbIsEPS;
  37     bool mbIsTransparent;
  38     bool mbIsAlpha;
  39
  40     sal_uInt32 mnAnimationLoopCount;
  41     sal_Int32 mnPageIndex;
  42 };
  43
  44 class OutputDevice;
  45 class GfxLink;
  46 class ImpSwapFile;
  47 class GraphicConversionParameters;
  48 class ImpGraphic;
  49
  50 enum class GraphicContentType : sal_Int32
  51 {
  52     Bitmap,
  53     Animation,
  54     Vector
  55 };
  56
  57 class VCL_DLLPUBLIC ImpGraphic final
  58 {
  59     friend class Graphic;
  60     friend class GraphicID;
  61     friend class vcl::graphic::Manager;
  62
  63 private:
  64
  65     GDIMetaFile                  maMetaFile;
  66     BitmapEx                     maBitmapEx;
  67     /// If maBitmapEx is empty, this preferred size will be set on it when it gets initialized.
  68     Size                         maExPrefSize;
  69     ImpSwapInfo                  maSwapInfo;
  70     std::unique_ptr<Animation>   mpAnimation;
  71     std::shared_ptr<GraphicReader> mpContext;
  72     std::shared_ptr<ImpSwapFile> mpSwapFile;
  73     std::shared_ptr<GfxLink>     mpGfxLink;
  74     GraphicType                  meType;
  75     mutable sal_uLong            mnSizeBytes;
  76     bool                         mbSwapOut;
  77     bool                         mbDummyContext;
  78     std::shared_ptr<VectorGraphicData> maVectorGraphicData;
  79     // cache checksum computation
  80     mutable BitmapChecksum       mnChecksum = 0;
  81
  82     std::unique_ptr<GraphicID>   mpGraphicID;
  83     GraphicExternalLink          maGraphicExternalLink;
  84
  85     std::chrono::high_resolution_clock::time_point maLastUsed;
  86     bool mbPrepared;
  87
  88 public:
  89     ImpGraphic();
  90     ImpGraphic( const ImpGraphic& rImpGraphic );
  91     ImpGraphic( ImpGraphic&& rImpGraphic ) noexcept;
  92     ImpGraphic( const GraphicExternalLink& rExternalLink);
  93     ImpGraphic(std::shared_ptr<GfxLink> const& rGfxLink, sal_Int32 nPageIndex = 0);
  94     ImpGraphic( const BitmapEx& rBmpEx );
  95     ImpGraphic(const std::shared_ptr<VectorGraphicData>& rVectorGraphicDataPtr);
  96     ImpGraphic( const Animation& rAnimation );
  97     ImpGraphic( const GDIMetaFile& rMtf );
  98     ~ImpGraphic();
  99
 100     void setPrepared(bool bAnimated, const Size* pSizeHint);
 101
 102 private:
 103
 104     ImpGraphic&         operator=( const ImpGraphic& rImpGraphic );
 105     ImpGraphic&         operator=( ImpGraphic&& rImpGraphic );
 106     bool                operator==( const ImpGraphic& rImpGraphic ) const;
 107     bool                operator!=( const ImpGraphic& rImpGraphic ) const { return !( *this == rImpGraphic ); }
 108
 109     OUString const & getOriginURL() const
 110     {
 111         return maGraphicExternalLink.msURL;
 112     }
 113
 114     void setOriginURL(OUString const & rOriginURL)
 115     {
 116         maGraphicExternalLink.msURL = rOriginURL;
 117     }
 118
 119     OString getUniqueID()
 120     {
 121         if (!mpGraphicID)
 122             mpGraphicID.reset(new GraphicID(*this));
 123         return mpGraphicID->getIDString();
 124     }
 125
 126     void createSwapInfo();
 127     void restoreFromSwapInfo();
 128
 129     void                clearGraphics();
 130     void                clear();
 131
 132     GraphicType         getType() const { return meType;}
 133     void                setDefaultType();
 134     bool                isSupportedGraphic() const;
 135
 136     bool                isTransparent() const;
 137     bool                isAlpha() const;
 138     bool                isAnimated() const;
 139     bool                isEPS() const;
 140
 141     bool isAvailable() const;
 142     bool makeAvailable();
 143
 144     Bitmap              getBitmap(const GraphicConversionParameters& rParameters) const;
 145     BitmapEx            getBitmapEx(const GraphicConversionParameters& rParameters) const;
 146     /// Gives direct access to the contained BitmapEx.
 147     const BitmapEx&     getBitmapExRef() const;
 148     Animation           getAnimation() const;
 149     const GDIMetaFile&  getGDIMetaFile() const;
 150
 151     Size                getSizePixel() const;
 152
 153     Size                getPrefSize() const;
 154     void                setPrefSize( const Size& rPrefSize );
 155
 156     MapMode             getPrefMapMode() const;
 157     void                setPrefMapMode( const MapMode& rPrefMapMode );
 158
 159     sal_uLong           getSizeBytes() const;
 160
 161     void                draw(OutputDevice& rOutDev, const Point& rDestPt) const;
 162     void                draw(OutputDevice& rOutDev, const Point& rDestPt,
 163                              const Size& rDestSize) const;
 164
 165     void                startAnimation(OutputDevice& rOutDev,
 166                                        const Point& rDestPt,
 167                                        const Size& rDestSize,
 168                                        tools::Long nExtraData,
 169                                        OutputDevice* pFirstFrameOutDev);
 170     void                stopAnimation( const OutputDevice* pOutputDevice,
 171                                            tools::Long nExtraData );
 172
 173     void                setAnimationNotifyHdl( const Link<Animation*,void>& rLink );
 174     Link<Animation*,void> getAnimationNotifyHdl() const;
 175
 176     sal_uInt32          getAnimationLoopCount() const;
 177
 178 private:
 179     // swapping methods
 180     bool swapInFromStream(SvStream& rStream);
 181     bool swapInGraphic(SvStream& rStream);
 182
 183     bool swapInContent(SvStream& rStream);
 184     bool swapOutContent(SvStream& rStream);
 185     bool swapOutGraphic(SvStream& rStream);
 186     // end swapping
 187
 188     std::shared_ptr<GraphicReader>& getContext() { return mpContext;}
 189     void                setContext( const std::shared_ptr<GraphicReader>& pReader );
 190     void                setDummyContext( bool value ) { mbDummyContext = value; }
 191     bool                isDummyContext() const { return mbDummyContext; }
 192     void                setGfxLink( const std::shared_ptr<GfxLink>& );
 193     const std::shared_ptr<GfxLink> & getSharedGfxLink() const;
 194     GfxLink             getGfxLink() const;
 195     bool                isGfxLink() const;
 196
 197     BitmapChecksum      getChecksum() const;
 198
 199     const std::shared_ptr<VectorGraphicData>& getVectorGraphicData() const;
 200
 201     /// Gets the bitmap replacement for a vector graphic.
 202     BitmapEx getVectorGraphicReplacement() const;
 203
 204     bool ensureAvailable () const;
 205
 206     sal_Int32 getPageNumber() const;
 207
 208     // Set the pref size, but don't force swap-in
 209     void setValuesForPrefSize(const Size& rPrefSize);
 210     // Set the pref map mode, but don't force swap-in
 211     void setValuesForPrefMapMod(const MapMode& rPrefMapMode);
 212
 213 public:
 214     void resetChecksum() { mnChecksum = 0; }
 215     bool swapIn();
 216     bool swapOut();
 217     bool isSwappedOut() const { return mbSwapOut; }
 218     OUString getSwapFileURL() const;
 219     // public only because of use in GraphicFilter
 220     void updateFromLoadedGraphic(ImpGraphic* graphic);
 221 };
 222
 223 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */