shell/inc/internal/contentreader.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_SHELL_INC_INTERNAL_CONTENTREADER_HXX
  21 #define INCLUDED_SHELL_INC_INTERNAL_CONTENTREADER_HXX
  22
  23 #include "internal/basereader.hxx"
  24 #include <stack>
  25
  26 class ITag;
  27 class StreamInterface;
  28
  29 class CContentReader : public CBaseReader
  30 {
  31 public:
  32     virtual ~CContentReader();
  33
  34     CContentReader( const std::string& DocumentName, LocaleSet_t const & DocumentLocale );
  35
  36     CContentReader( StreamInterface* stream, LocaleSet_t const & DocumentLocale );
  37
  38
  39     /** Get the chunkbuffer.
  40
  41         @return
  42         the chunkbuffer of the document.
  43     */
  44     inline ChunkBuffer_t const & getChunkBuffer( ) const{ return m_ChunkBuffer; };
  45
  46 protected: // protected because its only an implementation relevant class
  47
  48     /** start_element occurs when a tag is start.
  49
  50         @param raw_name
  51         raw name of the tag.
  52         @param local_name
  53         local name of the tag.
  54         @param attributes
  55         attribute structure.
  56     */
  57     virtual void start_element(
  58         const std::wstring& raw_name,
  59         const std::wstring& local_name,
  60         const XmlTagAttributes_t& attributes);
  61
  62     /** end_element occurs when a tag is closed
  63
  64         @param raw_name
  65         raw name of the tag.
  66         @param local_name
  67         local name of the tag.
  68     */
  69     virtual void end_element(
  70         const std::wstring& raw_name, const std::wstring& local_name);
  71
  72     /** characters occurs when receiving characters
  73
  74         @param character
  75         content of the information received.
  76     */
  77     virtual void characters(const std::wstring& character);
  78
  79 protected:
  80     /** choose an appropriate tag reader to handle the tag.
  81
  82         @param tag_name
  83         the name of the tag.
  84         @param XmlAttributes
  85         attribute structure of the tag to save in.
  86     */
  87     ITag* chooseTagReader(
  88         const std::wstring& tag_name, const XmlTagAttributes_t& XmlAttributes );
  89
  90     /** Get the list of style locale pair.
  91
  92         @return
  93         the Style-Locale map
  94     */
  95     inline StyleLocaleMap_t const & getStyleMap( ) const{ return m_StyleMap; };
  96
  97     /** get style of the current content.
  98
  99         @return style of the current content.
 100     */
 101     ::std::wstring getCurrentContentStyle();
 102
 103     /** add chunk into Chunk Buffer.
 104     */
 105     void addChunk( LocaleSet_t const & Locale, Content_t const & Content );
 106
 107     /** get a style's locale field.
 108     */
 109     LocaleSet_t const & getLocale( const StyleName_t& Style );
 110
 111 private:
 112     std::stack<ITag*> m_TagBuilderStack;
 113
 114     ChunkBuffer_t   m_ChunkBuffer;
 115     StyleLocaleMap_t      m_StyleMap;
 116     LocaleSet_t m_DefaultLocale;
 117 };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */