include/svtools/svparser.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_SVTOOLS_SVPARSER_HXX
  21 #define INCLUDED_SVTOOLS_SVPARSER_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24 #include <tools/link.hxx>
  25 #include <tools/ref.hxx>
  26 #include <tools/solar.h>
  27 #include <rtl/textenc.h>
  28 #include <rtl/ustring.hxx>
  29 #include <vector>
  30 #include <memory>
  31
  32 template<typename T> struct SvParser_Impl;
  33 class SvStream;
  34
  35 enum class SvParserState
  36 {
  37     Accepted = 0,
  38     NotStarted,
  39     Working,
  40     Pending,
  41     Error
  42 };
  43
  44 template<typename T>
  45 class SVT_DLLPUBLIC SvParser : public SvRefBase
  46 {
  47     DECL_LINK( NewDataRead, LinkParamNone*, void );
  48
  49 protected:
  50     SvStream&           rInput;
  51     OUString            aToken;             // scanned token
  52     sal_uLong           nlLineNr;           // current line number
  53     sal_uLong           nlLinePos;          // current column number
  54
  55     std::unique_ptr<SvParser_Impl<T>> pImplData; // internal data
  56     long                m_nTokenIndex;      // current token index to detect loops for seeking backwards
  57     long                nTokenValue;        // additional value (RTF)
  58     bool                bTokenHasValue;     // indicates whether nTokenValue is valid
  59     SvParserState       eState;             // status also in derived classes
  60
  61     rtl_TextEncoding    eSrcEnc;            // Source encoding
  62
  63     sal_uInt64          nNextChPos;
  64     sal_uInt32          nNextCh;            // current character codepoint in UTF32 for the "lex"
  65
  66     bool                bUCS2BSrcEnc : 1;   // or as big-endian UCS2
  67     bool                bSwitchToUCS2 : 1;  // switching is allowed
  68     bool                bRTF_InTextRead : 1;  // only for RTF-Parser!!!
  69
  70     struct TokenStackType
  71     {
  72         OUString    sToken;
  73         long        nTokenValue;
  74         bool        bTokenHasValue;
  75         T           nTokenId;
  76
  77         TokenStackType();
  78     };
  79
  80     // methods for Token stack
  81     T SkipToken( short nCnt = -1 );       // "skip" n Tokens back
  82     TokenStackType* GetStackPtr( short nCnt );
  83
  84     // scan the next token:
  85     //  work off Token stack and call GetNextToken_() if necessary.
  86     //  That one is responsible for the recognition of new Tokens.
  87     T GetNextToken();
  88     virtual T GetNextToken_() = 0;
  89
  90     // is called for each Token that is recognized in CallParser
  91     virtual void NextToken( T nToken ) = 0;
  92
  93     // at times of SvRefBase derivation, not everybody may delete
  94     virtual ~SvParser() override;
  95
  96     void ClearTxtConvContext();
  97
  98 private:
  99     std::unique_ptr<TokenStackType[]> pTokenStack;
 100     TokenStackType *pTokenStackPos;
 101     sal_uInt8 nTokenStackSize, nTokenStackPos;
 102
 103 public:
 104     SvParser( SvStream& rIn, sal_uInt8 nStackSize = 3 );
 105
 106     virtual  SvParserState CallParser() = 0; // calling of the parser
 107
 108     SvParserState GetStatus() const;  // StatusInfo
 109
 110     sal_uLong    GetLineNr() const;
 111     sal_uLong    GetLinePos() const;
 112     void         IncLineNr();
 113     sal_uLong    IncLinePos();
 114     void         SetLineNr( sal_uLong nlNum );
 115     void         SetLinePos( sal_uLong nlPos );
 116
 117     sal_uInt32 GetNextChar();   // Return next Unicode codepoint in UTF32.
 118     void RereadLookahead();
 119
 120     bool IsParserWorking() const;
 121
 122     Link<LinkParamNone*,void> GetAsynchCallLink() const;
 123
 124     // for asynchronous reading from the SvStream
 125     void SaveState( T nToken );
 126     void RestoreState();
 127     virtual void Continue( T nToken );
 128
 129     // Set/get source encoding. The UCS2BEncoding flag is valid if source
 130     // encoding is UCS2. It specifies a big endian encoding.
 131     void SetSrcEncoding( rtl_TextEncoding eSrcEnc );
 132     rtl_TextEncoding GetSrcEncoding() const;
 133
 134     // May the character set be switched to UCS/2, if a BOM
 135     // is in the first two characters of the stream?
 136     void SetSwitchToUCS2( bool bSet );
 137     bool IsSwitchToUCS2() const;
 138
 139     // how many bytes a character consists of
 140     sal_uInt16 GetCharSize() const;
 141
 142     T GetSaveToken() const;
 143 };
 144
 145 // build a Which-Map 'rWhichMap' from an array of WhichIds
 146 // 'pWhichIds'. It has the length 'nWhichIds'.
 147 // The WhichMap is not deleted.
 148 SVT_DLLPUBLIC void BuildWhichTable( std::vector<sal_uInt16> &rWhichMap,
 149                                sal_uInt16 const *pWhichIds,
 150                                sal_uInt16 nWhichIds );
 151
 152 /*========================================================================
 153  *
 154  * SvKeyValue.
 155  *
 156  *======================================================================*/
 157
 158 class SvKeyValue
 159 {
 160     /** Representation.
 161     */
 162     OUString m_aKey;
 163     OUString m_aValue;
 164
 165 public:
 166     /** Construction.
 167     */
 168     SvKeyValue()
 169     {}
 170
 171     SvKeyValue (const OUString &rKey, const OUString &rValue)
 172         : m_aKey (rKey), m_aValue (rValue)
 173     {}
 174
 175     SvKeyValue (const SvKeyValue &rOther)
 176         : m_aKey (rOther.m_aKey), m_aValue (rOther.m_aValue)
 177     {}
 178
 179     /** Assignment.
 180     */
 181     SvKeyValue& operator= (SvKeyValue const &rOther)
 182     {
 183         m_aKey   = rOther.m_aKey;
 184         m_aValue = rOther.m_aValue;
 185         return *this;
 186     }
 187
 188     /** Operation.
 189     */
 190     const OUString& GetKey() const { return m_aKey; }
 191     const OUString& GetValue() const { return m_aValue; }
 192 };
 193
 194 /*========================================================================
 195  *
 196  * SvKeyValueIterator.
 197  *
 198  *======================================================================*/
 199
 200 class SVT_DLLPUBLIC SvKeyValueIterator : public SvRefBase
 201 {
 202     struct Impl;
 203     std::unique_ptr<Impl> mpImpl;
 204
 205 public:
 206     /** Construction/Destruction.
 207     */
 208     SvKeyValueIterator();
 209     virtual ~SvKeyValueIterator() override;
 210     SvKeyValueIterator(const SvKeyValueIterator&) = delete;
 211     SvKeyValueIterator& operator=( const SvKeyValueIterator& ) = delete;
 212
 213     /** Operation.
 214     */
 215     virtual bool GetFirst (SvKeyValue &rKeyVal);
 216     virtual bool GetNext  (SvKeyValue &rKeyVal);
 217     virtual void Append   (const SvKeyValue &rKeyVal);
 218 };
 219
 220 typedef tools::SvRef<SvKeyValueIterator> SvKeyValueIteratorRef;
 221
 222 #endif // INCLUDED_SVTOOLS_SVPARSER_HXX
 223
 224 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */