/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#pragma once

#include <svtools/svtdllapi.h>

#include <tools/link.hxx>

#include <tools/ref.hxx>

#include <tools/long.hxx>

#include <rtl/textenc.h>

#include <rtl/ustrbuf.hxx>

#include <rtl/ustring.hxx>

#include <memory>

#include <utility>

template<typename T> struct SvParser_Impl;

class SvStream;

enum class SvParserState

{

    Accepted = 0,

    NotStarted,

    Working,

    Pending,

    Error

};

template<typename T>

class SVT_DLLPUBLIC SvParser : public SvRefBase

{

    DECL_DLLPRIVATE_LINK( NewDataRead, LinkParamNone*, void );

protected:

    SvStream&           rInput;

    OUStringBuffer      aToken;             // scanned token

    sal_uInt32          nlLineNr;           // current line number

    sal_uInt32          nlLinePos;          // current column number

    sal_uInt32          nConversionErrors;  // count of conversion errors

    std::unique_ptr<SvParser_Impl<T>> pImplData; // internal data

    tools::Long                m_nTokenIndex;      // current token index to detect loops for seeking backwards

    tools::Long                nTokenValue;        // additional value (RTF)

    bool                bTokenHasValue;     // indicates whether nTokenValue is valid

    bool                bFuzzing;           // indicates we are in Fuzzing mode

    SvParserState       eState;             // status also in derived classes

    rtl_TextEncoding    eSrcEnc;            // Source encoding

    sal_uInt64          nNextChPos;

    sal_uInt32          nNextCh;            // current character codepoint in UTF32 for the "lex"

    bool                bSwitchToUCS2 : 1;  // switching is allowed

    bool                bRTF_InTextRead : 1;  // only for RTF-Parser!!!

    struct TokenStackType

    {

        OUString    sToken;

        tools::Long        nTokenValue;

        bool        bTokenHasValue;

        T           nTokenId;

        TokenStackType();

    };

    // methods for Token stack

    T SkipToken( short nCnt = -1 );       // "skip" n Tokens back

    TokenStackType* GetStackPtr( short nCnt );

    // scan the next token:

    //  work off Token stack and call GetNextToken_() if necessary.

    //  That one is responsible for the recognition of new Tokens.

    T GetNextToken();

    virtual T GetNextToken_() = 0;

    // is called for each Token that is recognized in CallParser

    virtual void NextToken( T nToken ) = 0;

    // at times of SvRefBase derivation, not everybody may delete

    virtual ~SvParser() override;

    void ClearTxtConvContext();

private:

    std::unique_ptr<TokenStackType[]> pTokenStack;

    TokenStackType *pTokenStackPos;

    sal_uInt8 nTokenStackSize, nTokenStackPos;

public:

    SvParser( SvStream& rIn, sal_uInt8 nStackSize = 3 );

    virtual  SvParserState CallParser() = 0; // calling of the parser

    SvParserState GetStatus() const;  // StatusInfo

    sal_uInt32   GetLineNr() const;

    sal_uInt32   GetLinePos() const;

    void         IncLineNr();

    sal_uInt32   IncLinePos();

    void         SetLineNr( sal_uInt32 nlNum );

    void         SetLinePos( sal_uInt32 nlPos );

    sal_uInt32 GetNextChar();   // Return next Unicode codepoint in UTF32.

    void RereadLookahead();

    bool IsParserWorking() const;

    Link<LinkParamNone*,void> GetAsynchCallLink() const;

    // for asynchronous reading from the SvStream

    void SaveState( T nToken );

    void RestoreState();

    virtual void Continue( T nToken );

    // Set/get source encoding. The UCS2BEncoding flag is valid if source

    // encoding is UCS2. It specifies a big endian encoding.

    void SetSrcEncoding( rtl_TextEncoding eSrcEnc );

    rtl_TextEncoding GetSrcEncoding() const;

    // May the character set be switched to UCS/2, if a BOM

    // is in the first two characters of the stream?

    void SetSwitchToUCS2( bool bSet );

    bool IsSwitchToUCS2() const;

    // how many bytes a character consists of

    sal_uInt16 GetCharSize() const;

    T GetSaveToken() const;

};

/*========================================================================

 *

 * SvKeyValue.

 *

 *======================================================================*/

class SvKeyValue

{

    /** Representation.

    */

    OUString m_aKey;

    OUString m_aValue;

public:

    /** Construction.

    */

    SvKeyValue()

    {}

    SvKeyValue (OUString aKey, OUString aValue)

        : m_aKey (std::move(aKey)), m_aValue (std::move(aValue))

    {}

    SvKeyValue (const SvKeyValue &rOther)

        : m_aKey (rOther.m_aKey), m_aValue (rOther.m_aValue)

    {}

    /** Assignment.

    */

    SvKeyValue& operator= (SvKeyValue const &rOther)

    {

        m_aKey   = rOther.m_aKey;

        m_aValue = rOther.m_aValue;

        return *this;

    }

    /** Operation.

    */

    const OUString& GetKey() const { return m_aKey; }

    const OUString& GetValue() const { return m_aValue; }

};

/*========================================================================

 *

 * SvKeyValueIterator.

 *

 *======================================================================*/

class SVT_DLLPUBLIC SvKeyValueIterator : public SvRefBase

{

    struct Impl;

    std::unique_ptr<Impl> mpImpl;

public:

    /** Construction/Destruction.

    */

    SvKeyValueIterator();

    virtual ~SvKeyValueIterator() override;

    SvKeyValueIterator(const SvKeyValueIterator&) = delete;

    SvKeyValueIterator& operator=( const SvKeyValueIterator& ) = delete;

    /** Operation.

    */

    virtual bool GetFirst (SvKeyValue &rKeyVal);

    virtual bool GetNext  (SvKeyValue &rKeyVal);

    virtual void Append   (const SvKeyValue &rKeyVal);

};

typedef tools::SvRef<SvKeyValueIterator> SvKeyValueIteratorRef;

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */