starmath/inc/document.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 #ifndef INCLUDED_STARMATH_INC_DOCUMENT_HXX
  21 #define INCLUDED_STARMATH_INC_DOCUMENT_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <rtl/strbuf.hxx>
  25 #include <sfx2/docfac.hxx>
  26 #include <sfx2/objsh.hxx>
  27 #include <sot/storage.hxx>
  28 #include <svl/lstner.hxx>
  29 #include <vcl/jobset.hxx>
  30 #include <vcl/virdev.hxx>
  31 #include <sax/fshelper.hxx>
  32 #include <unotools/lingucfg.hxx>
  33 #include <oox/core/filterbase.hxx>
  34 #include <oox/mathml/import.hxx>
  35 #include <oox/export/utils.hxx>
  36
  37 #include <memory>
  38 #include <set>
  39
  40 #include "format.hxx"
  41 #include "parse.hxx"
  42 #include "smmod.hxx"
  43 #include "smdllapi.hxx"
  44
  45 class SfxPrinter;
  46 class Printer;
  47 class SmCursor;
  48
  49 #define STAROFFICE_XML  "StarOffice XML (Math)"
  50 #define MATHML_XML      "MathML XML (Math)"
  51
  52 /* Access to printer should happen through this class only
  53  * ==========================================================================
  54  *
  55  * The printer can belong to the document or the OLE-Container. If the document
  56  * is an OLE-Document the printer generally belongs to the container too.
  57  * But the container maybe works with a different MapUnit than the server.
  58  * Referring to the MapMode the printer will be accordingly adjusted in the
  59  * constructor and restored in the destructor. This brings that this class
  60  * is always allowed to exists only a short time (e.g. while painting).
  61  * The control whether the printer is self-generated, gotten from the server
  62  * or is NULL then, is taken by the DocShell in the method GetPrt(), for
  63  * which the access is friend of the DocShell too.
  64  */
  65
  66 class SmDocShell;
  67 class EditEngine;
  68
  69 class SmPrinterAccess
  70 {
  71     VclPtr<Printer> pPrinter;
  72     VclPtr<OutputDevice> pRefDev;
  73 public:
  74     explicit SmPrinterAccess( SmDocShell &rDocShell );
  75     ~SmPrinterAccess();
  76     Printer* GetPrinter()  { return pPrinter.get(); }
  77     OutputDevice* GetRefDev()  { return pRefDev.get(); }
  78 };
  79
  80 void SetEditEngineDefaultFonts(SfxItemPool &rEditEngineItemPool, const SvtLinguOptions &rOpt);
  81
  82 class SM_DLLPUBLIC SmDocShell : public SfxObjectShell, public SfxListener
  83 {
  84     friend class SmPrinterAccess;
  85     friend class SmCursor;
  86
  87     OUString            maText;
  88     SmFormat            maFormat;
  89     SmParser            maParser;
  90     OUString            maAccText;
  91     SvtLinguOptions     maLinguOptions;
  92     std::unique_ptr<SmTableNode> mpTree;
  93     SfxItemPool        *mpEditEngineItemPool;
  94     std::unique_ptr<EditEngine> mpEditEngine;
  95     VclPtr<SfxPrinter>  mpPrinter;       //q.v. comment to SmPrinter Access!
  96     VclPtr<Printer>     mpTmpPrinter;    //ditto
  97     sal_uInt16          mnModifyCount;
  98     bool                mbFormulaArranged;
  99     std::unique_ptr<SmCursor> mpCursor;
 100     std::set< OUString >    maUsedSymbols;   // to export used symbols only when saving
 101
 102
 103     virtual void Notify(SfxBroadcaster& rBC, const SfxHint& rHint) override;
 104
 105     bool        WriteAsMathType3( SfxMedium& );
 106
 107     virtual void        Draw(OutputDevice *pDevice,
 108                              const JobSetup & rSetup,
 109                              sal_uInt16 nAspect) override;
 110
 111     virtual void        FillClass(SvGlobalName* pClassName,
 112                                   SotClipboardFormatId*  pFormat,
 113                                   OUString* pAppName,
 114                                   OUString* pFullTypeName,
 115                                   OUString* pShortTypeName,
 116                                   sal_Int32 nFileFormat,
 117                                   bool bTemplate = false ) const override;
 118
 119     virtual void        OnDocumentPrinterChanged( Printer * ) override;
 120     virtual bool        InitNew( const css::uno::Reference< css::embed::XStorage >& xStorage ) override;
 121     virtual bool        Load( SfxMedium& rMedium ) override;
 122     virtual bool        Save() override;
 123     virtual bool        SaveAs( SfxMedium& rMedium ) override;
 124
 125     Printer             *GetPrt();
 126     OutputDevice*       GetRefDev();
 127
 128     void                SetFormulaArranged(bool bVal) { mbFormulaArranged = bVal; }
 129
 130     virtual bool        ConvertFrom(SfxMedium &rMedium) override;
 131
 132     /** Called whenever the formula is changed
 133      * Deletes the current cursor
 134      */
 135     void                InvalidateCursor();
 136
 137 public:
 138     SFX_DECL_INTERFACE(SFX_INTERFACE_SMA_START+SfxInterfaceId(1))
 139
 140     SFX_DECL_OBJECTFACTORY();
 141
 142 private:
 143     /// SfxInterface initializer.
 144     static void InitInterface_Impl();
 145
 146 public:
 147     explicit SmDocShell( SfxModelFlags i_nSfxCreationFlags );
 148     virtual     ~SmDocShell() override;
 149
 150     virtual bool        ConvertTo( SfxMedium &rMedium ) override;
 151
 152     // For unit tests, not intended to use in other context
 153     void SetGreekCharStyle(sal_Int16 nVal) { maFormat.SetGreekCharStyle(nVal); }
 154
 155     static void LoadSymbols();
 156     static void SaveSymbols();
 157
 158     void        ArrangeFormula();
 159
 160     //Access for the View. This access is not for the OLE-case!
 161     //and for the communication with the SFX!
 162     //All internal printer uses should work with the SmPrinterAccess only
 163     bool        HasPrinter()    { return mpPrinter != nullptr; }
 164     SfxPrinter *GetPrinter()    { GetPrt(); return mpPrinter; }
 165     void        SetPrinter( SfxPrinter * );
 166
 167     const OUString GetComment() const;
 168
 169     // to replace chars that can not be saved with the document...
 170     void        ReplaceBadChars();
 171
 172     void        UpdateText();
 173     void        SetText(const OUString& rBuffer);
 174     const OUString&  GetText() { return maText; }
 175     void        SetFormat(SmFormat const & rFormat);
 176     const SmFormat&  GetFormat() { return maFormat; }
 177
 178     void            Parse();
 179     SmParser &      GetParser() { return maParser; }
 180     const SmTableNode *GetFormulaTree() const  { return mpTree.get(); }
 181     void            SetFormulaTree(SmTableNode *pTree) { mpTree.reset(pTree); }
 182
 183     const std::set< OUString > &    GetUsedSymbols() const  { return maUsedSymbols; }
 184
 185     OUString const & GetAccessibleText();
 186
 187     EditEngine &    GetEditEngine();
 188     SfxItemPool &   GetEditEngineItemPool();
 189     const SvtLinguOptions & GetLinguOptions() const { return maLinguOptions; }
 190
 191     void        DrawFormula(OutputDevice &rDev, Point &rPosition, bool bDrawSelection = false);
 192     Size        GetSize();
 193
 194     void        Repaint();
 195
 196     virtual ::svl::IUndoManager *GetUndoManager () override;
 197
 198     static SfxItemPool& GetPool();
 199
 200     void        Execute( SfxRequest& rReq );
 201     void        GetState(SfxItemSet &);
 202
 203     virtual void SetVisArea (const tools::Rectangle & rVisArea) override;
 204     virtual void SetModified(bool bModified = true) override;
 205
 206     /** Get a cursor for modifying this document
 207      * @remarks Don't store this reference, a new cursor may be made...
 208      */
 209     SmCursor&   GetCursor();
 210     /** True, if cursor have previously been requested and thus
 211      * has some sort of position.
 212      */
 213     bool        HasCursor();
 214
 215     void writeFormulaOoxml(const ::sax_fastparser::FSHelperPtr& pSerializer,
 216             oox::core::OoxmlVersion version,
 217             oox::drawingml::DocumentType documentType);
 218     void writeFormulaRtf(OStringBuffer& rBuffer, rtl_TextEncoding nEncoding);
 219     void readFormulaOoxml( oox::formulaimport::XmlStream& stream );
 220 };
 221
 222 #endif
 223
 224 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */