sw/inc/iodetect.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_SW_INC_IODETECT_HXX
  21 #define INCLUDED_SW_INC_IODETECT_HXX
  22
  23 #include <osl/endian.h>
  24 #include <rtl/ustring.hxx>
  25 #include <sfx2/docfilt.hxx>
  26 #include <sfx2/docfile.hxx>
  27 #include <sfx2/fcontnr.hxx>
  28 #include <swdllapi.h>
  29
  30 #define FILTER_RTF      "RTF"       ///< RTF filter
  31 #define sRtfWH          "WH_RTF"
  32 #define FILTER_TEXT     "TEXT"      ///< text filter with default codeset
  33 #define FILTER_BAS      "BAS"       ///< StarBasic (identical to ANSI)
  34 #define FILTER_WW8      "CWW8"      ///< WinWord 97 filter
  35 #define FILTER_TEXT_DLG "TEXT_DLG"  ///< text filter with encoding dialog
  36 #define FILTER_XML      "CXML"      ///< XML filter
  37 #define FILTER_XMLV     "CXMLV"     ///< XML filter
  38 #define FILTER_XMLVW    "CXMLVWEB"  ///< XML filter
  39 #define FILTER_DOCX     "OXML"
  40 #define sHTML           "HTML"
  41 #define sWW5            "WW6"
  42 #define sWW6            "CWW6"
  43
  44 #define sSWRITER        "swriter"
  45 #define sSWRITERWEB     "swriter/web"
  46
  47 struct SwIoDetect
  48 {
  49     const OUString sName;
  50
  51     SwIoDetect(const OUString &rN)
  52         : sName(rN)
  53     {
  54     }
  55
  56     bool IsFilter( const OUString& rNm ) const
  57     {
  58         return rNm.startsWith(sName);
  59     }
  60 };
  61
  62 enum ReaderWriterEnum {
  63     READER_WRITER_RTF,
  64     READER_WRITER_BAS,
  65     READER_WRITER_WW6,
  66     READER_WRITER_WW8,
  67     READER_WRITER_RTF_WH,
  68     READER_WRITER_HTML,
  69     READER_WRITER_WW5,
  70     READER_WRITER_XML,
  71     READER_WRITER_TEXT_DLG,
  72     READER_WRITER_TEXT,
  73     READER_WRITER_DOCX,
  74     MAXFILTER
  75 };
  76
  77 extern SwIoDetect aFilterDetect[];
  78
  79 /** The following class is a wrapper for basic i/o functions of Writer 3.0.
  80  Everything is static. All filter names mentioned are Writer-internal
  81  names, i.e. the names in front of the equality sign in INSTALL.INI, like SWG
  82  or ASCII.*/
  83
  84 class SwIoSystem
  85 {
  86 public:
  87     /// find for an internal format name the corresponding filter entry
  88     SW_DLLPUBLIC static std::shared_ptr<const SfxFilter>
  89         GetFilterOfFormat( const OUString& rFormat,
  90             const SfxFilterContainer* pCnt = nullptr );
  91
  92     /** Detect for the given file which filter should be used. The filter name
  93      is returned. If no filter could be found, the name of the ASCII filter
  94      is returned! */
  95     static std::shared_ptr<const SfxFilter> GetFileFilter(const OUString& rFileName);
  96
  97     static bool IsValidStgFilter( SotStorage& , const SfxFilter& );
  98     static bool IsValidStgFilter( const css::uno::Reference < css::embed::XStorage >& rStg, const SfxFilter& rFilter);
  99
 100     static bool IsDetectableText( const sal_Char* pBuf, sal_uLong &rLen,
 101             rtl_TextEncoding *pCharSet, bool *pSwap, LineEnd *pLineEnd=nullptr );
 102
 103     static const OUString GetSubStorageName( const SfxFilter& rFltr );
 104 };
 105
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */