sw/source/filter/inc/msfilter.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: msfilter.hxx,v $
  10  * $Revision: 1.18 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil -*- */
  31 /// @HTML
  32
  33 #ifndef SW_MS_MSFILTER_HXX
  34 #define SW_MS_MSFILTER_HXX
  35
  36 #include <set>
  37 #include <map>
  38 #include <vector>
  39 #   include <swtypes.hxx>       //SwTwips
  40 #   include <tools/string.hxx>  //String
  41 #   include "wwstyles.hxx"      //ww::sti
  42 #   include <rtl/textenc.h>     //rtl_TextEncoding
  43 #   include <tools/gen.hxx>     //Size
  44 #include <tools/datetime.hxx>
  45 #include <fltshell.hxx>         // fuer den Attribut Stack
  46 #include <redline.hxx>
  47 #include <shellio.hxx>
  48 #include <svtools/zforlist.hxx>
  49
  50 #define CREATE_CONST_ASC(s) String::CreateFromAscii( RTL_CONSTASCII_STRINGPARAM(s))
  51
  52 class SwDoc;
  53 class SwPaM;
  54 class String;
  55 class SwTableNode;
  56 class SwNodeIndex;
  57 class SwNoTxtNode;
  58 class SwTxtNode;
  59 class WW8TabDesc;
  60
  61 namespace myImplHelpers
  62 {
  63 template<class C> class StyleMapperImpl;
  64 }
  65
  66 class SwTxtFmtColl;
  67 class SwCharFmt;
  68 typedef myImplHelpers::StyleMapperImpl<SwTxtFmtColl> ParaMapper;
  69 typedef myImplHelpers::StyleMapperImpl<SwCharFmt> CharMapper;
  70
  71 namespace sw
  72 {
  73     namespace ms
  74     {
  75         /** MSOffice appears to set the charset of unicode fonts to MS 932
  76
  77             Arial Unicode MS for example is a unicode font, but word sets
  78             exported uses of it to the MS 932 charset
  79
  80             @param eTextEncoding
  81                 the OOo encoding to convert from
  82
  83             @return
  84                 a msoffice equivalent charset identifier
  85
  86             @author
  87                 <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
  88         */
  89         sal_uInt8 rtl_TextEncodingToWinCharset(rtl_TextEncoding eTextEncoding);
  90
  91         /** Import a MSWord XE field. Suitable for .doc and .rtf
  92
  93             @param rDoc
  94                 the document to insert into
  95
  96             @param rPaM
  97                 the position in the document to insert into
  98
  99             @param rXE
 100                 the arguments of the original word XE field
 101
 102             @author
 103                 <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 104         */
 105         void ImportXE(SwDoc &rDoc, SwPaM &rPaM, const String &rXE);
 106
 107         /** Convert from DTTM to Writer's DateTime
 108
 109             @author
 110                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a
 111         */
 112         DateTime DTTM2DateTime( long lDTTM );
 113
 114         /** Convert from DTTM to Writer's DateTime
 115
 116             @author
 117                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a
 118         */
 119         long DateTime2DTTM( const DateTime& rDT );
 120
 121         /** Convert from Word Date/Time field str to Writer's Date Time str
 122
 123             @author
 124                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a
 125         */
 126         ULONG MSDateTimeFormatToSwFormat(String& rParams, SvNumberFormatter *pFormatter, USHORT &rLang, bool bHijri);
 127
 128         /** Used by MSDateTimeFormatToSwFormat to identify AM time fields
 129
 130             @author
 131                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a
 132         */
 133         bool IsNotAM(String& rParams, xub_StrLen nPos);
 134
 135         /** Another function used by MSDateTimeFormatToSwFormat
 136
 137             @author
 138                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a
 139         */
 140         void SwapQuotesInField(String &rFmt);
 141
 142     }
 143
 144     namespace util
 145     {
 146         struct AuthorInfo;
 147         typedef AuthorInfo* AuthorInfo_Ptr;
 148
 149         /// Redlining Authors
 150         struct AuthorInfo
 151         {
 152             USHORT nWWAuthorId;
 153             USHORT nOurId;
 154
 155             AuthorInfo(USHORT nWWAuthorId_, USHORT nOurId_ = 0):
 156                 nWWAuthorId( nWWAuthorId_ ),
 157                 nOurId(      nOurId_ )
 158                 {}
 159             bool operator==(const AuthorInfo& rEntry) const
 160             {
 161                 return (nWWAuthorId == rEntry.nWWAuthorId);
 162             }
 163             bool operator<(const AuthorInfo& rEntry) const
 164             {
 165                 return (nWWAuthorId < rEntry.nWWAuthorId);
 166             }
 167         };
 168
 169         SV_DECL_PTRARR_SORT_DEL(AuthorInfos, AuthorInfo_Ptr,16,16)
 170
 171         /** Clips a value to MAX/MIN 16bit value to make it safe for use
 172             as a position value to give to writer. i.e. +-57.8cm. Sometimes
 173             we see ridiculous values for positioning in rtf and word document,
 174             this captures such ones and clips them to values which are
 175             still outside the document, but of a value that doesn't cause
 176             problems for writer's layout, e.g. see
 177             http://www.openoffice.org/issues/show_bug.cgi?id=i9245
 178
 179             @param nIn
 180
 181             @return nIn clipped to min/max 16bit value
 182
 183             @author
 184                 <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 185         */
 186         SwTwips MakeSafePositioningValue(SwTwips nIn);
 187
 188         /** Knows which writer style a given word style should be imported as
 189
 190             Mapping a word style to a writer style has to consider mapping
 191             the word builtin styles like "Normal" as the default root style
 192             to our default root style which is called "Default" in english,
 193             and "Normal" in german.
 194
 195             Additionally it then has to avoid name collisions such as
 196
 197             a) styles "Normal" and "Default" in a single document, where
 198             we can use the original distinct names "Normal" and "Default" and..
 199             b) styles "Normal" and "Default" in a single document, where
 200             we can not use the original names, and must come up with an
 201             alternative name for one of them..
 202
 203             And it needs to report to the importer if the style being mapped to
 204             was already in existance, for the cut and paste/insert file mode we
 205             should not modify the returned style if it is already in use as it
 206             is does not belong to us to change.
 207
 208             @author
 209                 <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 210         */
 211         class ParaStyleMapper
 212         {
 213         private:
 214             //I hate these things stupid pImpl things, but its warranted here
 215             ParaMapper *mpImpl;
 216         public:
 217             ParaStyleMapper(SwDoc &rDoc);
 218             ~ParaStyleMapper();
 219
 220             /** StyleResult
 221                 StyleResult is a std::pair of a pointer to a style and a flag
 222                 which is true if the style existed previously in the document.
 223             */
 224             typedef std::pair<SwTxtFmtColl*, bool> StyleResult;
 225
 226             /** Get the writer style which the word style should map to
 227
 228                 @param rName
 229                 The name of the word style
 230
 231                 @param eSti
 232                 The style id of the word style, we are really only interested
 233                 in knowing if the style has either a builtin standard id, or is
 234                 a user defined style.
 235
 236                 @return
 237                 The equivalent writer style packaged as a StyleResult to use
 238                 for this word style.
 239
 240                 It will only return a failure in the pathological case of
 241                 catastropic failure elsewhere of there exist already styles
 242                 rName and WW-rName[0..SAL_MAX_INT32], which is both unlikely
 243                 and impossible.
 244             */
 245             StyleResult GetStyle(const String& rName, ww::sti eSti);
 246         };
 247
 248         /** Knows which writer style a given word style should be imported as
 249
 250             Mapping a word style to a writer style has to consider mapping
 251             the word builtin styles like "Normal" as the default root style
 252             to our default root style which is called "Default" in english,
 253             and "Normal" in german.
 254
 255             Additionally it then has to avoid name collisions such as
 256
 257             a) styles "Normal" and "Default" in a single document, where
 258             we can use the original distinct names "Normal" and "Default" and..
 259             b) styles "Normal" and "Default" in a single document, where
 260             we can not use the original names, and must come up with an
 261             alternative name for one of them..
 262
 263             And it needs to report to the importer if the style being mapped to
 264             was already in existance, for the cut and paste/insert file mode we
 265             should not modify the returned style if it is already in use as it
 266             is does not belong to us to change.
 267
 268             @author
 269                 <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 270         */
 271         class CharStyleMapper
 272         {
 273         private:
 274             //I hate these things stupid pImpl things, but its warranted here
 275             CharMapper *mpImpl;
 276         public:
 277             CharStyleMapper(SwDoc &rDoc);
 278             ~CharStyleMapper();
 279
 280             /** StyleResult
 281                 StyleResult is a std::pair of a pointer to a style and a flag
 282                 which is true if the style existed previously in the document.
 283             */
 284             typedef std::pair<SwCharFmt*, bool> StyleResult;
 285
 286             /** Get the writer style which the word style should map to
 287
 288                 @param rName
 289                 The name of the word style
 290
 291                 @param eSti
 292                 The style id of the word style, we are really only interested
 293                 in knowing if the style has either a builtin standard id, or is
 294                 a user defined style.
 295
 296                 @return
 297                 The equivalent writer style packaged as a StyleResult to use
 298                 for this word style.
 299
 300                 It will only return a failure in the pathological case of
 301                 catastropic failure elsewhere of there exist already styles
 302                 rName and WW-rName[0..SAL_MAX_INT32], which is both unlikely
 303                 and impossible.
 304             */
 305             StyleResult GetStyle(const String& rName, ww::sti eSti);
 306         };
 307
 308         /** Find suitable names for exporting this font
 309
 310             Given a fontname description find the best primary and secondary
 311             fallback font to use from MSWord's persp font
 312
 313             @author
 314             <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 315
 316             @see #i10242#/#i19164# for examples
 317         */
 318         class FontMapExport
 319         {
 320         public:
 321             String msPrimary;
 322             String msSecondary;
 323             bool HasDistinctSecondary() const;
 324             FontMapExport(const String &rFontDescription);
 325         };
 326
 327         class InsertedTableClient : public SwClient
 328         {
 329         public:
 330             InsertedTableClient(SwTableNode & rNode);
 331             SwTableNode * GetTableNode();
 332         };
 333
 334         /** Handle requirements for table formatting in insert->file mode.
 335
 336             When inserting a table into a document which already has been
 337             formatted and laid out (e.g using insert->file) then tables
 338             must be handled in a special way, (or so previous comments and
 339             code in the filters leads me to believe).
 340
 341             Before the document is finalized the new tables need to have
 342             their layout frms deleted and recalculated. This TableManager
 343             detects the necessity to do this, and all tables inserted into
 344             a document should be registered with this manager with
 345             InsertTable, and before finialization DelAndMakeTblFrms should
 346             be called.
 347
 348             @author
 349             <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 350
 351             @see #i25782# for examples
 352         */
 353         class InsertedTablesManager
 354         {
 355         public:
 356             typedef std::map<InsertedTableClient *, SwNodeIndex *> TblMap;
 357             typedef TblMap::iterator TblMapIter;
 358             void DelAndMakeTblFrms();
 359             void InsertTable(SwTableNode &rTableNode, SwPaM &rPaM);
 360             InsertedTablesManager(const SwDoc &rDoc);
 361         private:
 362             bool mbHasRoot;
 363             TblMap maTables;
 364         };
 365
 366         /**
 367             @author
 368                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a>
 369          */
 370         class RedlineStack
 371         {
 372         private:
 373             std::vector<SwFltStackEntry *> maStack;
 374             typedef std::vector<SwFltStackEntry *>::reverse_iterator myriter;
 375             SwDoc &mrDoc;
 376         public:
 377             explicit RedlineStack(SwDoc &rDoc) : mrDoc(rDoc) {}
 378             void open(const SwPosition& rPos, const SfxPoolItem& rAttr);
 379             bool close(const SwPosition& rPos, RedlineType_t eType);
 380             void close(const SwPosition& rPos, RedlineType_t eType,
 381                 WW8TabDesc* pTabDesc );
 382             void closeall(const SwPosition& rPos);
 383             ~RedlineStack();
 384         private:
 385             //No copying
 386             RedlineStack(const RedlineStack&);
 387             RedlineStack& operator=(const RedlineStack&);
 388         };
 389
 390         /**
 391             @author
 392                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a>
 393          */
 394         class SetInDocAndDelete
 395         {
 396         private:
 397             SwDoc &mrDoc;
 398         public:
 399             explicit SetInDocAndDelete(SwDoc &rDoc) : mrDoc(rDoc) {}
 400             void operator()(SwFltStackEntry *pEntry);
 401         private:
 402             //No assignment
 403             SetInDocAndDelete& operator=(const SetInDocAndDelete&);
 404         };
 405
 406         /**
 407             @author
 408                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a>
 409          */
 410         class CloseIfOpen       //Subclass from something ?
 411         {
 412         private:
 413             const SwPosition &mrPos;
 414         public:
 415             explicit CloseIfOpen(const SwPosition &rPos) : mrPos(rPos) {}
 416                 void operator()(SwFltStackEntry *pEntry) const
 417             {
 418                 if (pEntry->bLocked)
 419                     pEntry->SetEndPos(mrPos);
 420             }
 421         private:
 422             //No assignment
 423             CloseIfOpen& operator=(const CloseIfOpen&);
 424         };
 425
 426         /**
 427             @author
 428                 <a href="mailto:mmaher@openoffice.org">Martin Maher</a>
 429          */
 430         class CompareRedlines:
 431             public std::binary_function<const SwFltStackEntry*, const SwFltStackEntry*,
 432             bool>
 433         {
 434         public:
 435             bool operator()(const SwFltStackEntry *pOneE, const SwFltStackEntry *pTwoE)
 436                 const;
 437         };
 438
 439         class WrtRedlineAuthor
 440         {
 441         protected:
 442             std::vector<String> maAuthors;          // Array of Sw - Bookmarknames
 443
 444             USHORT GetPos( const String& rNm );
 445
 446             //No copying
 447             WrtRedlineAuthor(const WrtRedlineAuthor&);
 448             WrtRedlineAuthor& operator=(const WrtRedlineAuthor&);
 449         public:
 450             WrtRedlineAuthor() {}
 451             virtual ~WrtRedlineAuthor() {}
 452
 453             USHORT AddName( const String& rNm );
 454             virtual void Write(Writer &rWrt) = 0;
 455             // std::vector<String> GetNames();
 456         };
 457
 458         /** Given a SwNoTxtNode (ole/graphic) get original size
 459
 460             Get the uncropped and unscaled size of the underlying graphic or
 461             ole object associated with a given SwNoTxtNode.
 462
 463             This function will swap in the graphic if it is swapped out from
 464             the graphic or object cache, but will swap it out if that was the
 465             case, i.e.  rNd is logically unchanged before and after
 466             GetSwappedInSize, though not physically const
 467
 468             @param rNd
 469                 the SwNoTxtNode whose objects original size we want
 470
 471             @return
 472                 the uncropped unscaled size of the SwNoTxtNode
 473
 474             @author
 475                 <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 476         */
 477         Size GetSwappedInSize(const SwNoTxtNode& rNd);
 478
 479         struct CharRunEntry
 480         {
 481             xub_StrLen mnEndPos;
 482             sal_uInt16 mnScript;
 483             rtl_TextEncoding meCharSet;
 484             bool mbRTL;
 485             CharRunEntry(xub_StrLen nEndPos, sal_uInt16 nScript,
 486                 rtl_TextEncoding eCharSet, bool bRTL)
 487             : mnEndPos(nEndPos), mnScript(nScript), meCharSet(eCharSet),
 488             mbRTL(bRTL)
 489             {
 490             }
 491         };
 492
 493         typedef std::vector<CharRunEntry> CharRuns;
 494         typedef CharRuns::const_iterator cCharRunIter;
 495
 496         /** Collect the ranges of Text which share
 497
 498             Word generally requires characters which share the same direction,
 499             the same script, and occasionally (depending on the format) the
 500             same charset to be exported in independant chunks.
 501
 502             So this function finds these ranges and returns a STL container
 503             of CharRuns
 504
 505             @param rTxtNd
 506                 The TextNode we want to ranges from
 507
 508             @param nStart
 509                 The position in the TxtNode to start processing from
 510
 511             @param bSplitOnCharSet
 512                 Set to true is we want to split on ranges of characters that
 513                 share a plausible charset for export to e.g. WW7- or perhaps
 514                 RTF format, not necessary for a unicode aware format like WW8+
 515
 516             @return STL container of CharRuns which describe the shared
 517             direction, script and optionally script of the contigious sequences
 518             of characters
 519
 520             @author
 521             <a href="mailto:cmc@openoffice.org">Caol&aacute;n McNamara</a>
 522
 523             @see #i22537# for example
 524         */
 525         CharRuns GetPseudoCharRuns(const SwTxtNode& rTxtNd,
 526             xub_StrLen nStart = 0, bool bSplitOnCharSet = false);
 527     }
 528 }
 529
 530 #endif
 531 /* vi:set tabstop=4 shiftwidth=4 expandtab: */